ifw::fgf::common::State Struct Reference

State struct defining enums to handle states/substates. More...

#include <state.hpp>

Public Types
enum class	StateEnum : short { OFF = -8 , UNDEFINED = -7 , NOT_OPERATIONAL = 1 , OPERATIONAL = 2 }
	State enums definition. More...
enum class	SubstateEnum : short {   UNDEFINED = 90 , ERROR = 95 , NOT_OP_NOT_READY = 100 , INITIALISING = 101 ,   NOT_OP_READY = 102 , ENABLING = 103 , IDLE = 110 , BUSY = 115 ,   ACQUIRING = 130 }
	Substate enums definition. More...
using	StateNumMap_t = boost::bimap<std::string, StateEnum>
using	SubstateNumMap_t = boost::bimap<std::string, SubstateEnum>

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

Static Public Attributes
static StateNumMap_t	StateMap
static SubstateNumMap_t	SubstateMap

Detailed Description

State struct defining enums to handle states/substates.

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 ifw::fgf::common::State::StateNumMap_t = boost::bimap<std::string, StateEnum>

SubstateNumMap_t

using ifw::fgf::common::State::SubstateNumMap_t = boost::bimap<std::string, SubstateEnum>

Member Enumeration Documentation

StateEnum

enum class ifw::fgf::common::State::StateEnum : short

strong

State enums definition.

Enumerator
OFF
UNDEFINED
NOT_OPERATIONAL
OPERATIONAL

SubstateEnum

enum class ifw::fgf::common::State::SubstateEnum : short

strong

Substate enums definition.

Enumerator
UNDEFINED
ERROR
NOT_OP_NOT_READY
INITIALISING
NOT_OP_READY
ENABLING
IDLE
BUSY
ACQUIRING

Member Function Documentation

GetState()

static std::optional< StateEnum > ifw::fgf::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 > ifw::fgf::common::State::GetStateStr ( const StateEnum state )

inlinestatic

Get state as an optional string.

Parameters

state

enumeration of the state

Returns

GetSubstate()

static std::optional< SubstateEnum > ifw::fgf::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 > ifw::fgf::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 ifw::fgf::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 ifw::fgf::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_IDLE_STR,          SubstateEnum::IDLE)
               (SUBSTATE_BUSY_STR,          SubstateEnum::BUSY)
               (SUBSTATE_ACQUIRING_STR,     SubstateEnum::ACQUIRING)

---

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

• fgf/common/src/include/ifw/fgf/common/state.hpp