openfluid::utils::ReportingData< C, M > Class Template Reference

Detailed Description

template<typename C, typename M>
class openfluid::utils::ReportingData< C, M >

A template structure to store reporting data. A report is madde of categories. Each category is a list of report items. Each report item is made of a message and a status.

Template Parameters

C	the data type for categories
M	the data type for messages

#include <utils/ReportingData.hpp>

Classes
struct	ReportingItem
struct	ReportingList

Public Types
enum class	ReportingStatus {   UNKNOWN , DISABLED , OK , WARNING ,   ERROR_STATUS }

Public Member Functions
ReportingStatus	getStatus () const

Public Attributes
std::map< C, ReportingList >	Categories

Member Enumeration Documentation

ReportingStatus

template<typename C , typename M >

enum openfluid::utils::ReportingData::ReportingStatus

strong

Enumerator
UNKNOWN
DISABLED
OK
WARNING
ERROR_STATUS

Member Function Documentation

getStatus()

template<typename C , typename M >

ReportingStatus openfluid::utils::ReportingData< C, M >::getStatus ( ) const

inline

Computes the overall status of the report

Member Data Documentation

Categories

template<typename C , typename M >

std::map<C,ReportingList> openfluid::utils::ReportingData< C, M >::Categories

Categories composing the report

---

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

• utils/ReportingData.hpp