MAV'RIC
/home/travis/build/lis-epfl/MAVRIC_Library/util/print_util.hpp
00001 /*******************************************************************************
00002  * Copyright (c) 2009-2016, MAV'RIC Development Team
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  * this list of conditions and the following disclaimer.
00010  *
00011  * 2. Redistributions in binary form must reproduce the above copyright notice,
00012  * this list of conditions and the following disclaimer in the documentation
00013  * and/or other materials provided with the distribution.
00014  *
00015  * 3. Neither the name of the copyright holder nor the names of its contributors
00016  * may be used to endorse or promote products derived from this software without
00017  * specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029  * POSSIBILITY OF SUCH DAMAGE.
00030  ******************************************************************************/
00031 
00032 /*******************************************************************************
00033  * \file print_util.h
00034  *
00035  * \author MAV'RIC Team
00036  * \author Felix Schill
00037  *
00038  * \brief Some utilities for printing strings and numbers
00039  *
00040  ******************************************************************************/
00041 
00042 
00043 #ifndef PRINT_UTIL_H
00044 #define PRINT_UTIL_H
00045 
00046 #ifdef __cplusplus
00047 extern "C"
00048 {
00049 #endif
00050 
00051 #include <stdbool.h>
00052 
00053 #include "util/streams.h"
00054 #include "util/quaternions.h"
00055 
00056 #define MAX_DIGITS 10
00057 #define MAX_DIGITS_LONG 20
00058 
00059 
00065 void print_util_dbg_print_init(byte_stream_t* debug_stream);
00066 
00067 
00073 byte_stream_t* print_util_get_debug_stream(void);
00074 
00075 
00082 void print_util_putstring(byte_stream_t* out_stream, const char* s);
00083 
00094 void print_util_putstring_length(byte_stream_t* out_stream, const char* s, unsigned long len);
00095 
00105 void print_util_putdigit(byte_stream_t* out_stream, uint32_t  c);
00106 
00107 
00115 void print_util_putnum(byte_stream_t* out_stream, int32_t c, char base);
00116 
00124 void print_util_putlong(byte_stream_t* out_stream, int64_t c, char base);
00125 
00133 void print_util_putfloat(byte_stream_t* out_stream, float c, int32_t after_digits);
00134 
00135 
00145 void print_util_print_matrix(byte_stream_t* out_stream, float const v[], int32_t rows, int32_t columns, int32_t after_digits);
00146 
00147 
00155 void print_util_print_vector(byte_stream_t* out_stream, float const v[], int32_t after_digits);
00156 
00157 
00165 void print_util_print_quaternion(byte_stream_t* out_stream, quat_t const* quat, int32_t after_digits);
00166 
00167 
00173 void print_util_dbg_print(const char* s);
00174 
00175 
00182 void print_util_dbg_print_num(int32_t c, char base);
00183 
00184 
00195 void print_util_dbg_log_value(const char* msg, int32_t value, char base);
00196 
00197 
00204 void print_util_dbg_putfloat(float c, int32_t after_digits);
00205 
00206 
00213 void print_util_dbg_print_vector(float const v[], int32_t after_digits);
00214 
00215 
00222 void print_util_dbg_print_quaternion(quat_t const* quat, int32_t after_digits);
00223 
00224 
00231 void print_util_dbg_print_long(int64_t c, char base);
00232 
00233 
00240 void print_util_dbg_init_msg(const char* module_name, bool init_success);
00241 
00242 
00248 void print_util_dbg_sep(char c);
00249 
00250 
00251 
00252 #ifdef __cplusplus
00253 }
00254 #endif
00255 
00256 #endif
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines