humoto
Static Public Member Functions | List of all members
humoto::OctaveFormatter Class Reference

Detailed Description

A collection of functions which format data to be parsable by MATLAB/Octave.

Definition at line 18 of file logger.h.

#include <logger.h>

Static Public Member Functions

static void appendEntryName (std::string &name, const std::string &addition)
 Add a part to the given log entry name. More...
 
static void appendEntryName (std::string &name, const char *addition)
 Add a part to the given log entry name. More...
 
static void appendEntryName (std::string &name, const std::size_t index)
 Add a part to the given log entry name. More...
 
template<typename t_Scalar >
static void formatAndOutputEntry (std::ostream *out, const std::string &name, const std::vector< t_Scalar > &vector)
 Format and output a log entry (std::vector) More...
 
template<typename t_Scalar , int t_rows, int t_cols, int t_flags>
static void formatAndOutputEntry (std::ostream *out, const std::string &name, const Eigen::Matrix< t_Scalar, t_rows, t_cols, t_flags > &matrix)
 Format and output a log entry (Eigen matrix) More...
 
static void formatAndOutputEntry (std::ostream *out, const std::string &name, const std::string &string)
 Format and output a log entry (std::string) More...
 
template<typename t_Data >
static void formatAndOutputEntry (std::ostream *out, const std::string &name, const t_Data &data)
 Format and output a log entry (default) More...
 
static const Eigen::IOFormat & getEigenMatrixFormat ()
 Returns format description for Eigen matrices. More...
 

Member Function Documentation

◆ appendEntryName() [1/3]

static void humoto::OctaveFormatter::appendEntryName ( std::string &  name,
const std::string &  addition 
)
inlinestatic

Add a part to the given log entry name.

Parameters
[in]namename
[in]additionsubname

Definition at line 41 of file logger.h.

◆ appendEntryName() [2/3]

static void humoto::OctaveFormatter::appendEntryName ( std::string &  name,
const char *  addition 
)
inlinestatic

Add a part to the given log entry name.

Parameters
[in]namename
[in]additionsubname

Definition at line 58 of file logger.h.

◆ appendEntryName() [3/3]

static void humoto::OctaveFormatter::appendEntryName ( std::string &  name,
const std::size_t  index 
)
inlinestatic

Add a part to the given log entry name.

Parameters
[in]namename
[in]indexindex of a subentry

Definition at line 75 of file logger.h.

◆ formatAndOutputEntry() [1/4]

template<typename t_Scalar >
static void humoto::OctaveFormatter::formatAndOutputEntry ( std::ostream *  out,
const std::string &  name,
const std::vector< t_Scalar > &  vector 
)
inlinestatic

Format and output a log entry (std::vector)

Template Parameters
t_Scalartype of vector elements
Parameters
[in,out]outoutput stream
[in]namename of the log entry
[in]vectordata vector

Definition at line 93 of file logger.h.

◆ formatAndOutputEntry() [2/4]

template<typename t_Scalar , int t_rows, int t_cols, int t_flags>
static void humoto::OctaveFormatter::formatAndOutputEntry ( std::ostream *  out,
const std::string &  name,
const Eigen::Matrix< t_Scalar, t_rows, t_cols, t_flags > &  matrix 
)
inlinestatic

Format and output a log entry (Eigen matrix)

Template Parameters
t_Scalar(Eigen) scalar type
t_rows(Eigen) number of rows
t_cols(Eigen) number of columns
t_flags(Eigen) flags
Parameters
[in,out]outoutput stream
[in]namename of the log entry
[in]matrixmatrix

Definition at line 123 of file logger.h.

◆ formatAndOutputEntry() [3/4]

static void humoto::OctaveFormatter::formatAndOutputEntry ( std::ostream *  out,
const std::string &  name,
const std::string &  string 
)
inlinestatic

Format and output a log entry (std::string)

Template Parameters
t_Datadata type
Parameters
[in,out]outoutput stream
[in]namename of the log entry
[in]stringstring

Definition at line 139 of file logger.h.

◆ formatAndOutputEntry() [4/4]

template<typename t_Data >
static void humoto::OctaveFormatter::formatAndOutputEntry ( std::ostream *  out,
const std::string &  name,
const t_Data &  data 
)
inlinestatic

Format and output a log entry (default)

Template Parameters
t_Datadata type
Parameters
[in,out]outoutput stream
[in]namename of the log entry
[in]datadata

Definition at line 156 of file logger.h.

◆ getEigenMatrixFormat()

static const Eigen::IOFormat& humoto::OctaveFormatter::getEigenMatrixFormat ( )
inlinestatic

Returns format description for Eigen matrices.

Returns
Eigen IO format

Definition at line 26 of file logger.h.


The documentation for this class was generated from the following file: