miscellaneous.h file for this module. Contains prototypes, includes and defines. More...
#include <stdio.h>#include <stdlib.h>#include <ctype.h>#include <string.h>#include <math.h>#include <time.h>#include <iostream>#include <vector>#include <Eigen/Dense>#include <armadillo>#include <types.h>

Go to the source code of this file.
| 
 | |
| #define | BLACK 0 | 
| #define | BLINK 4 | 
| #define | BLUE 4 | 
| #define | BRIGHT 1 | 
| #define | CYAN 6 | 
| #define | DIM 2 | 
| #define | GRAY 7 | 
| #define | GREEN 2 | 
| #define | HIDDEN 8 | 
| #define | MAGENTA 5 | 
| #define | PFLN {printf("Passing through File [%s] @ Line [%d].\n", __FILE__, __LINE__);} | 
| #define | RED 1 | 
| #define | RESET 0 | 
| #define | REVERSE 7 | 
| #define | UNDERLINE 3 | 
| #define | WHITE 8 | 
| #define | YELLOW 3 | 
| void | CalculateAverageCartesianSpeed (double diffX, double diffY, double diffZ, long double time_interval, double *return_vector) | 
| Function acumulate position differences and calculate average speed.   | |
| template<typename Type > | |
| Type | DegToRad (Type deg) | 
| Templated degree to radian conversion function.   | |
| double | get_sign (double x) | 
| Function to determine sign of a given number.   | |
| double | GetDblFromKeyboard (void) | 
| Gets a double number from keyboard input.   | |
| int | GetNbrFromKeyboard (void) | 
| Gets a number from keyboard input.   | |
| char | GetStrFromKeyboard (void) | 
| Gets a character from keyboard input.   | |
| void | HighLightText (void) | 
| Make somesort of highlight text.   | |
| int | isNumeric (const char *s) | 
| Function to check if string is numeric.   | |
| template<typename Type > | |
| bool | IsWithinRange (Type value, Type lower_bound, Type upper_bound) | 
| Template function to determine if a given value is within a give range.   | |
| template<class T > | |
| T | pc_mean (std::vector< T > vect) | 
| Template function to calculate mean value of an array.   | |
| double | pc_mean (double *v, int len) | 
| Function to calculate mean value of an array [Taken from http://rosettacode.org/].   | |
| void | print_greeting (shared_vars_t *RobotVars) | 
| Prints to stdout the program greeting.   | |
| void | print_help (void) | 
| Prints to stdout the program help tips.   | |
| void | PrintRedLine (void) | 
| Printf of an horizontal separator red line.   | |
| template<typename Type > | |
| Type | RadToDeg (Type rad) | 
| Templated radian to degree conversion function.   | |
| void | ResetTextColors (void) | 
| Reset color text.   | |
| template<typename Type > | |
| Type | RetrievePrecisionFromDouble (Type original, Type precision) | 
| Retrieve a value cropped with the required precision.   | |
| Eigen::Matrix3d | rotx (double angle_in_degrees) | 
| Function to calculate rotation matrix over the X axis.   | |
| Eigen::Matrix3d | roty (double angle_in_degrees) | 
| Function to calculate rotation matrix over the Y axis.   | |
| Eigen::Matrix3d | rotz (double angle_in_degrees) | 
| Function to calculate rotation matrix over the Z axis.   | |
| void | ScreenClear (void) | 
| Sends equivalent shell command "clean" to stdout.   | |
| void | textcolor (int attr, int fg, int bg) | 
| FUNCTIONS CREATED BY VITOR SANTOS(vitor@ua.pt) | ALL CREDITS GO TO HIM... :-).   | |
miscellaneous.h file for this module. Contains prototypes, includes and defines.
This modules contains several functions used overall.
Definition in file miscellaneous.h.
| #define BLACK 0 | 
@ Colors
Definition at line 277 of file miscellaneous.h.
| #define BLINK 4 | 
Definition at line 270 of file miscellaneous.h.
| #define BLUE 4 | 
Definition at line 281 of file miscellaneous.h.
| #define BRIGHT 1 | 
Definition at line 267 of file miscellaneous.h.
| #define CYAN 6 | 
Definition at line 283 of file miscellaneous.h.
| #define DIM 2 | 
Definition at line 268 of file miscellaneous.h.
| #define GRAY 7 | 
Definition at line 284 of file miscellaneous.h.
| #define GREEN 2 | 
Definition at line 279 of file miscellaneous.h.
| #define HIDDEN 8 | 
Definition at line 272 of file miscellaneous.h.
| #define MAGENTA 5 | 
Definition at line 282 of file miscellaneous.h.
| #define PFLN {printf("Passing through File [%s] @ Line [%d].\n", __FILE__, __LINE__);} | 
Definition at line 55 of file miscellaneous.h.
| #define RED 1 | 
Definition at line 278 of file miscellaneous.h.
| #define RESET 0 | 
@ Attributes
Definition at line 266 of file miscellaneous.h.
| #define REVERSE 7 | 
Definition at line 271 of file miscellaneous.h.
| #define UNDERLINE 3 | 
Definition at line 269 of file miscellaneous.h.
| #define WHITE 8 | 
Definition at line 285 of file miscellaneous.h.
| #define YELLOW 3 | 
Definition at line 280 of file miscellaneous.h.
| void CalculateAverageCartesianSpeed | ( | double | diffX, | |
| double | diffY, | |||
| double | diffZ, | |||
| long double | time_interval, | |||
| double * | return_vector | |||
| ) | 
Function acumulate position differences and calculate average speed.
This function stores position diffencial values and calculates mean value over time.
| [in] | diffX | xx axis position differences. | 
| [in] | diffY | yy axis position differences. | 
| [in] | diffZ | zz axis position differences. | 
| [in] | time_interval | time intervals of each given space differences. | 
| [out] | return_vector | destination return array. | 
Definition at line 121 of file miscellaneous.cpp.
| Type DegToRad | ( | Type | deg | ) |  [inline] | 
        
Templated degree to radian conversion function.
| [in] | deg | angle in degrees. | 
Definition at line 79 of file miscellaneous.h.
| double get_sign | ( | double | x | ) | 
Function to determine sign of a given number.
This function determines the sign of a number and return -1 or 1, for negative or positive respectively.
| [in] | x | number to evaluate. | 
Definition at line 254 of file miscellaneous.cpp.
| double GetDblFromKeyboard | ( | void | ) | 
Gets a double number from keyboard input.
This function retrieves a double number from a keyboard input.
Definition at line 275 of file miscellaneous.cpp.
| int GetNbrFromKeyboard | ( | void | ) | 
Gets a number from keyboard input.
This function retrieves a number from a keyboard input.
Definition at line 259 of file miscellaneous.cpp.
| char GetStrFromKeyboard | ( | void | ) | 
Gets a character from keyboard input.
This function retrieves a character from a keyboard input.
Definition at line 267 of file miscellaneous.cpp.
| void HighLightText | ( | void | ) | 
| int isNumeric | ( | const char * | s | ) | 
Function to check if string is numeric.
Returns true (non-zero) if character-string parameter represents a signed or unsigned floating-point number. Otherwise returns false (zero). [Taken from http://rosettacode.org/] | my edit: strtod() warning supression
| [in] | s | a const char array to evaluate. | 
Definition at line 244 of file miscellaneous.cpp.
| bool IsWithinRange | ( | Type | value, | |
| Type | lower_bound, | |||
| Type | upper_bound | |||
| ) |  [inline] | 
        
Template function to determine if a given value is within a give range.
| [in] | value | the value to evaluate. | 
| [in] | lower_bound | the lower bound of the range. | 
| [in] | upper_bound | the upper bound of the range. | 
Definition at line 173 of file miscellaneous.h.
| T pc_mean | ( | std::vector< T > | vect | ) |  [inline] | 
        
Template function to calculate mean value of an array.
This function calculates the mean value of an a given vector, that can be of any type.
| [in] | vect | vector to calculated mean. | 
Definition at line 155 of file miscellaneous.h.
| double pc_mean | ( | double * | v, | |
| int | len | |||
| ) | 
Function to calculate mean value of an array [Taken from http://rosettacode.org/].
| [in] | v | pointer to the array to calculate. | 
| [in] | len | lenght of array elements to use in the calculation. | 
Definition at line 235 of file miscellaneous.cpp.
| void print_greeting | ( | shared_vars_t * | RobotVars | ) | 
Prints to stdout the program greeting.
This function prints to stdout a greeting message.
| [in] | RobotVars | structure defined in types.h with the joint values. | 
Definition at line 91 of file miscellaneous.cpp.
| void print_help | ( | void | ) | 
Prints to stdout the program help tips.
This function prints to stdout a set of program help tips.
Definition at line 37 of file miscellaneous.cpp.
| void PrintRedLine | ( | void | ) | 
Printf of an horizontal separator red line.
Definition at line 294 of file miscellaneous.cpp.
| Type RadToDeg | ( | Type | rad | ) |  [inline] | 
        
Templated radian to degree conversion function.
| [in] | rad | angle in radians. | 
Definition at line 95 of file miscellaneous.h.
| void ResetTextColors | ( | void | ) | 
| Type RetrievePrecisionFromDouble | ( | Type | original, | |
| Type | precision | |||
| ) |  [inline] | 
        
Retrieve a value cropped with the required precision.
| [in] | original | the original value to be cropped. | 
| [in] | precision | the precision required. | 
Definition at line 65 of file miscellaneous.h.
| Eigen::Matrix3d rotx | ( | double | angle_in_degrees | ) | 
Function to calculate rotation matrix over the X axis.
| [in] | angle_in_degrees | angle for rotation. | 
Definition at line 157 of file miscellaneous.cpp.
| Eigen::Matrix3d roty | ( | double | angle_in_degrees | ) | 
Function to calculate rotation matrix over the Y axis.
| [in] | angle_in_degrees | angle for rotation. | 
Definition at line 183 of file miscellaneous.cpp.
| Eigen::Matrix3d rotz | ( | double | angle_in_degrees | ) | 
Function to calculate rotation matrix over the Z axis.
| [in] | angle_in_degrees | angle for rotation. | 
Definition at line 209 of file miscellaneous.cpp.
| void ScreenClear | ( | void | ) | 
Sends equivalent shell command "clean" to stdout.
Definition at line 283 of file miscellaneous.cpp.
| void textcolor | ( | int | attr, | |
| int | fg, | |||
| int | bg | |||
| ) | 
FUNCTIONS CREATED BY VITOR SANTOS(vitor@ua.pt) | ALL CREDITS GO TO HIM... :-).
Set the color of text that follows
| [in] | attr | Type of attribute (RESET, BRIGHT, BLINK, etc... | 
| [in] | fg | Color of foreground | 
| [in] | bg | Color of background | 
Definition at line 289 of file miscellaneous.cpp.