MIRA
Public Types | Public Member Functions | Public Attributes | List of all members
Status Class Reference

Status entry class. More...

#include <fw/Status.h>

Public Types

enum  StatusMode {
  OK, BOOTUP, RECOVER, WARNING,
  ERROR
}
 Different status levels sorted from "okay" to "most severe". More...
 

Public Member Functions

 Status ()
 
 Status (StatusMode iMode, const std::string &iCategory, const std::string &iTrText, const std::string &iMessage)
 Construct a new status with given mode, category and text. More...
 
bool operator== (const Status &other) const
 
template<typename Reflector >
void reflect (Reflector &r)
 

Public Attributes

StatusMode mode
 the status flag (OK, WARNING or ERROR) More...
 
std::string category
 category of that status More...
 
std::string trText
 Status text that can be used for translation of the error to other languages. More...
 
std::string message
 the corresponding message More...
 

Detailed Description

Status entry class.

Used to signal the current status of a module (OK, WARNING, ERROR)

Member Enumeration Documentation

◆ StatusMode

enum StatusMode

Different status levels sorted from "okay" to "most severe".

Enumerator
OK 
BOOTUP 
RECOVER 
WARNING 
ERROR 

Constructor & Destructor Documentation

◆ Status() [1/2]

Status ( )
inline

◆ Status() [2/2]

Status ( StatusMode  iMode,
const std::string &  iCategory,
const std::string &  iTrText,
const std::string &  iMessage 
)
inline

Construct a new status with given mode, category and text.

Member Function Documentation

◆ operator==()

bool operator== ( const Status other) const
inline

◆ reflect()

void reflect ( Reflector &  r)
inline

Member Data Documentation

◆ mode

StatusMode mode

the status flag (OK, WARNING or ERROR)

◆ category

std::string category

category of that status

◆ trText

std::string trText

Status text that can be used for translation of the error to other languages.

◆ message

std::string message

the corresponding message


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