Flair
Framework Libre Air
flair::core::cvmatrix_descriptor Class Reference

Class describing cvmatrix elements, for log and graphs purpose. More...

#include <cvmatrix_descriptor.h>

Public Member Functions

 cvmatrix_descriptor (uint32_t rows, uint32_t cols)
 Constructor. More...
 
 ~cvmatrix_descriptor ()
 Destructor. More...
 
void SetElementName (uint32_t row, uint32_t col, std::string name)
 Set element name. More...
 
std::string ElementName (uint32_t row, uint32_t col) const
 Element name. More...
 
uint32_t Rows (void) const
 Number of rows. More...
 
uint32_t Cols (void) const
 Number of colomns. More...
 

Detailed Description

Class describing cvmatrix elements, for log and graphs purpose.

This class allows to give a name to matrix elements. These names will be used in graphs and logs.

Constructor & Destructor Documentation

flair::core::cvmatrix_descriptor::cvmatrix_descriptor ( uint32_t  rows,
uint32_t  cols 
)

Constructor.

Construct a matrix descriptor.

Parameters
rowsmatrix rows
colsmatrix cols
flair::core::cvmatrix_descriptor::~cvmatrix_descriptor ( )

Destructor.

Member Function Documentation

void flair::core::cvmatrix_descriptor::SetElementName ( uint32_t  row,
uint32_t  col,
std::string  name 
)

Set element name.

Parameters
rowelement row
colelement col
nameelement name
std::string flair::core::cvmatrix_descriptor::ElementName ( uint32_t  row,
uint32_t  col 
) const

Element name.

Parameters
rowelement row
colelement col
Returns
element name
uint32_t flair::core::cvmatrix_descriptor::Rows ( void  ) const

Number of rows.

Returns
rows
uint32_t flair::core::cvmatrix_descriptor::Cols ( void  ) const

Number of colomns.

Returns
colomns