| 1 | // %flair:license{ |
|---|
| 2 | // This file is part of the Flair framework distributed under the |
|---|
| 3 | // CECILL-C License, Version 1.0. |
|---|
| 4 | // %flair:license} |
|---|
| 5 | /*! |
|---|
| 6 | * \file cvmatrix_descriptor.h |
|---|
| 7 | * \brief Class describing cvmatrix elements, for log and graphs purpose |
|---|
| 8 | * \author Guillaume Sanahuja, Copyright Heudiasyc UMR UTC/CNRS 7253 |
|---|
| 9 | * \date 2014/02/05 |
|---|
| 10 | * \version 4.0 |
|---|
| 11 | */ |
|---|
| 12 | |
|---|
| 13 | #ifndef CVMATRIX_DESCRIPTOR_H |
|---|
| 14 | #define CVMATRIX_DESCRIPTOR_H |
|---|
| 15 | |
|---|
| 16 | #include <string> |
|---|
| 17 | |
|---|
| 18 | namespace flair { namespace core |
|---|
| 19 | { |
|---|
| 20 | |
|---|
| 21 | /*! \class cvmatrix_descriptor |
|---|
| 22 | * |
|---|
| 23 | * \brief Class describing cvmatrix elements, for log and graphs purpose |
|---|
| 24 | * |
|---|
| 25 | * This class allows to give a name to matrix elements. These names |
|---|
| 26 | * will be used in graphs and logs. |
|---|
| 27 | */ |
|---|
| 28 | class cvmatrix_descriptor { |
|---|
| 29 | public: |
|---|
| 30 | /*! |
|---|
| 31 | * \brief Constructor |
|---|
| 32 | * |
|---|
| 33 | * Construct a matrix descriptor. |
|---|
| 34 | * |
|---|
| 35 | * \param rows matrix rows |
|---|
| 36 | * \param cols matrix cols |
|---|
| 37 | */ |
|---|
| 38 | cvmatrix_descriptor(uint32_t rows, uint32_t cols); |
|---|
| 39 | |
|---|
| 40 | /*! |
|---|
| 41 | * \brief Destructor |
|---|
| 42 | * |
|---|
| 43 | */ |
|---|
| 44 | ~cvmatrix_descriptor(); |
|---|
| 45 | |
|---|
| 46 | /*! |
|---|
| 47 | * \brief Set element name |
|---|
| 48 | * |
|---|
| 49 | * \param row element row |
|---|
| 50 | * \param col element col |
|---|
| 51 | * \param name element name |
|---|
| 52 | */ |
|---|
| 53 | void SetElementName(uint32_t row, uint32_t col,std::string name); |
|---|
| 54 | |
|---|
| 55 | /*! |
|---|
| 56 | * \brief Element name |
|---|
| 57 | * |
|---|
| 58 | * \param row element row |
|---|
| 59 | * \param col element col |
|---|
| 60 | * |
|---|
| 61 | * \return element name |
|---|
| 62 | */ |
|---|
| 63 | std::string ElementName(uint32_t row, uint32_t col) const; |
|---|
| 64 | |
|---|
| 65 | /*! |
|---|
| 66 | * \brief Number of rows |
|---|
| 67 | * |
|---|
| 68 | * \return rows |
|---|
| 69 | */ |
|---|
| 70 | uint32_t Rows(void) const; |
|---|
| 71 | |
|---|
| 72 | /*! |
|---|
| 73 | * \brief Number of colomns |
|---|
| 74 | * |
|---|
| 75 | * \return colomns |
|---|
| 76 | */ |
|---|
| 77 | uint32_t Cols(void) const; |
|---|
| 78 | |
|---|
| 79 | private: |
|---|
| 80 | uint32_t rows,cols; |
|---|
| 81 | std::string **element_names; |
|---|
| 82 | |
|---|
| 83 | }; |
|---|
| 84 | |
|---|
| 85 | } // end namespace core |
|---|
| 86 | } // end namespace flair |
|---|
| 87 | |
|---|
| 88 | #endif // CVMATRIX_DESCRIPTOR_H |
|---|
