sup::syssup::common::State Struct Reference

The State struct. More...

#include <states.hpp>

Public Types
enum	StateEnum : short { StateEnum::OFF = -8, StateEnum::UNDEFINED = -7, StateEnum::NOT_OPERATIONAL = 1, StateEnum::OPERATIONAL = 2 }
enum	SubstateEnum : short {   SubstateEnum::UNDEFINED = 90, SubstateEnum::ERROR = 95, SubstateEnum::NOT_OP_NOT_READY = 100, SubstateEnum::INITIALISING = 101,   SubstateEnum::NOT_OP_READY = 102, SubstateEnum::ENABLING = 103, SubstateEnum::RECOVERING = 106, SubstateEnum::IDLE = 110,   SubstateEnum::BUSY = 115, SubstateEnum::SETTING_UP = 130, SubstateEnum::NOT_RECORDING = 200, SubstateEnum::RECORDING = 201,   SubstateEnum::REC_PAUSED = 202 }
using	StateNumMap_t = boost::bimap< std::string, StateEnum >
using	SubstateNumMap_t = boost::bimap< std::string, SubstateEnum >

Static Public Member Functions
static StateEnum	GetState (const std::string &state)
	Get state as an enumeration. More...
static std::optional< std::string >	GetStateStr (const StateEnum state)
	Get state as an optional string. More...
static SubstateEnum	GetSubstate (const std::string &substate)
	Get state as an enumeration. More...
static std::optional< std::string >	GetSubstateStr (const SubstateEnum substate)
	Get substate as an optional string. More...

Static Public Attributes
static StateNumMap_t	StateMap
static SubstateNumMap_t	SubstateMap

Detailed Description

The State struct.

This structure is used store the basic state information. It has two bidirectional maps used by classes to get the name or enumeration associated to a state. Methods are static so they can be used without an object.

Member Typedef Documentation

StateNumMap_t

using sup::syssup::common::State::StateNumMap_t = boost::bimap<std::string, StateEnum>

SubstateNumMap_t

using sup::syssup::common::State::SubstateNumMap_t = boost::bimap<std::string, SubstateEnum>

Member Enumeration Documentation

StateEnum

enum sup::syssup::common::State::StateEnum : short

strong

Enumerator
OFF
UNDEFINED
NOT_OPERATIONAL
OPERATIONAL

SubstateEnum

enum sup::syssup::common::State::SubstateEnum : short

strong

Enumerator
UNDEFINED
ERROR
NOT_OP_NOT_READY
INITIALISING
NOT_OP_READY
ENABLING
RECOVERING
IDLE
BUSY
SETTING_UP
NOT_RECORDING
RECORDING
REC_PAUSED

Member Function Documentation

GetState()

static StateEnum sup::syssup::common::State::GetState ( const std::string &  state )

inlinestatic

Get state as an enumeration.

Parameters

state

string containing the state

Returns

GetStateStr()

static std::optional<std::string> sup::syssup::common::State::GetStateStr ( const StateEnum  state )

inlinestatic

Get state as an optional string.

Parameters

state

enumeration of the state

Returns

GetSubstate()

static SubstateEnum sup::syssup::common::State::GetSubstate ( const std::string &  substate )

inlinestatic

Get state as an enumeration.

Parameters

substate

string containing the substate

Returns

GetSubstateStr()

static std::optional<std::string> sup::syssup::common::State::GetSubstateStr ( const SubstateEnum  substate )

inlinestatic

Get substate as an optional string.

Parameters

substate

enumeration of the substate

Returns

Member Data Documentation

StateMap

StateNumMap_t sup::syssup::common::State::StateMap

inlinestatic

Initial value:

= boost::assign::list_of<State::StateNumMap_t::relation >
            ( STATE_OFF_STR,              StateEnum::OFF)
            ( STATE_UNDEFINED_STR,        StateEnum::UNDEFINED)
            ( STATE_NOT_OPERATIONAL_STR,  StateEnum::NOT_OPERATIONAL)
            ( STATE_OPERATIONAL_STR ,     StateEnum::OPERATIONAL)

SubstateMap

SubstateNumMap_t sup::syssup::common::State::SubstateMap

inlinestatic

Initial value:

= boost::assign::list_of<State::SubstateNumMap_t::relation >
              ( STATE_UNDEFINED_STR,          SubstateEnum::UNDEFINED)
              ( STATE_ERROR_STR,              SubstateEnum::ERROR)
              ( SUBSTATE_NOTREADY_STR,        SubstateEnum::NOT_OP_NOT_READY)
              ( SUBSTATE_INITIALISING_STR,    SubstateEnum::INITIALISING)
              ( SUBSTATE_READY_STR ,          SubstateEnum::NOT_OP_READY)
              ( SUBSTATE_ENABLING_STR,        SubstateEnum::ENABLING)
              ( SUBSTATE_RECOVERING_STR,      SubstateEnum::RECOVERING)
              ( SUBSTATE_IDLE_STR ,           SubstateEnum::IDLE)
              ( SUBSTATE_BUSY_STR ,           SubstateEnum::BUSY)
              ( SUBSTATE_SETTING_UP_STR ,     SubstateEnum::SETTING_UP)
              ( SUBSTATE_NOT_RECORDING_STR ,  SubstateEnum::NOT_RECORDING)
              ( SUBSTATE_RECORDING_STR ,      SubstateEnum::RECORDING)
              ( SUBSTATE_REC_PAUSED_STR ,     SubstateEnum::REC_PAUSED)

---

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

• syssup/common/src/include/sup/syssup/common/states.hpp