sup::syssup::common::SubsysData Struct Reference

The SubsysData struct. More...

#include <subsys.hpp>

Public Types
enum	ConnectionEnum : short { ConnectionEnum::CONNECTED = 10, ConnectionEnum::NOT_CONNECTED = 11 }

Public Member Functions
State::StateEnum	GetState () const
	GetState. More...
void	SetState (const std::string state)
	SetState. More...
State::SubstateEnum	GetSubstate () const
	GetSubstate. More...
void	SetSubstate (const std::string subtate)
	SetSubstate. More...
void	SetConnection (const SubsysData::ConnectionEnum connection)
	SetConnection. More...
ConnectionEnum	GetConnection () const
	GetConnection. More...
std::string	GetConnectionStr () const
	GetConnectionStr. More...

Public Attributes
const std::map< ConnectionEnum, std::string >	ConnectionMap

Protected Attributes
ConnectionEnum	m_connection {ConnectionEnum::NOT_CONNECTED}
	connection status More...
State::StateEnum	m_state
	actual state More...
State::SubstateEnum	m_substate
	actual substate More...

Detailed Description

The SubsysData struct.

This structure is used to store the basic status information about a subsystems managed by the Supervisor. Subsystem classes will get the status information from the subsystems and it will store it in this structure.

Member Enumeration Documentation

ConnectionEnum

enum sup::syssup::common::SubsysData::ConnectionEnum : short

strong

Enumerator
CONNECTED
NOT_CONNECTED

Member Function Documentation

GetConnection()

ConnectionEnum sup::syssup::common::SubsysData::GetConnection ( ) const

inline

GetConnection.

Returns

GetConnectionStr()

std::string sup::syssup::common::SubsysData::GetConnectionStr ( ) const

inline

GetConnectionStr.

Returns

GetState()

State::StateEnum sup::syssup::common::SubsysData::GetState ( ) const

inline

GetState.

Returns

GetSubstate()

State::SubstateEnum sup::syssup::common::SubsysData::GetSubstate ( ) const

inline

GetSubstate.

Returns

SetConnection()

void sup::syssup::common::SubsysData::SetConnection ( const SubsysData::ConnectionEnum  connection )

inline

SetConnection.

Parameters

connection

SetState()

void sup::syssup::common::SubsysData::SetState ( const std::string  state )

inline

SetState.

Parameters

state

SetSubstate()

void sup::syssup::common::SubsysData::SetSubstate ( const std::string  subtate )

inline

SetSubstate.

Parameters

subtate

Member Data Documentation

ConnectionMap

const std::map<ConnectionEnum, std::string> sup::syssup::common::SubsysData::ConnectionMap

Initial value:

{
          { ConnectionEnum::CONNECTED, "Connected" },
          { ConnectionEnum::NOT_CONNECTED, "ERROR - Not Connected" }
        }

m_connection

ConnectionEnum sup::syssup::common::SubsysData::m_connection {ConnectionEnum::NOT_CONNECTED}

protected

connection status

m_state

State::StateEnum sup::syssup::common::SubsysData::m_state

protected

actual state

m_substate

State::SubstateEnum sup::syssup::common::SubsysData::m_substate

protected

actual substate

---

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

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