sup::syssup::common::SubsystemConfig Struct Reference

#include <config.hpp>

Public Member Functions
std::optional< ScopeEnum >	GetScope (const std::string &scope_str) const
	Get associated subsystem scope.
ScopeEnum	GetScope () const
	Get actual subsystem scope.
void	SetScope (const ScopeEnum &scope)
	Set subsystem scope.
std::string	GetType () const
	Get actual subsystem type.
void	SetType (const std::string &type)
	Set subsystem type.
std::string	GetRrEndPoint () const
	Get actual subsystem Req/Rep end point.
void	SetRrEndPoint (const std::string &rr_endpoint)
	Set subsystem Req/Rep end point.
std::string	GetPsEndPoint () const
	Get actual subsystem Pub/Sub end point.
void	SetPsEndPoint (const std::string &ps_endpoint)
	Set subsystem Pub/Sub end point.
bool	GetAccess () const
	Get actual saccess flag.
void	SetAccess (const bool &access)
	Set subsystem access flag.
int	GetIndex () const
	Get index.
void	SetIndex (const int &index)
	Set subsystem access flag.

Detailed Description

This class provide access to subsystem configuration parameters read from the configuration file. Once configuration are read from the configuration file they can be modified at run-time.

Member Function Documentation

GetAccess()

bool sup::syssup::common::SubsystemConfig::GetAccess ( ) const

inline

Get actual saccess flag.

Returns

GetIndex()

int sup::syssup::common::SubsystemConfig::GetIndex ( ) const

inline

Get index.

Returns

GetPsEndPoint()

std::string sup::syssup::common::SubsystemConfig::GetPsEndPoint ( ) const

inline

Get actual subsystem Pub/Sub end point.

Returns

GetRrEndPoint()

std::string sup::syssup::common::SubsystemConfig::GetRrEndPoint ( ) const

inline

Get actual subsystem Req/Rep end point.

Returns

GetScope() [1/2]

ScopeEnum sup::syssup::common::SubsystemConfig::GetScope ( ) const

inline

Get actual subsystem scope.

Returns

GetScope() [2/2]

std::optional< ScopeEnum > sup::syssup::common::SubsystemConfig::GetScope ( const std::string &  scope_str ) const

inline

Get associated subsystem scope.

Parameters

scope_str

scope as string

Returns

scope as enumeration or std::nullopt in case is not found in map.

This method returns the associated enumeration to the scope string provided.

GetType()

std::string sup::syssup::common::SubsystemConfig::GetType ( ) const

inline

Get actual subsystem type.

Returns

SetAccess()

void sup::syssup::common::SubsystemConfig::SetAccess ( const bool &  access )

inline

Set subsystem access flag.

Parameters

access

SetIndex()

void sup::syssup::common::SubsystemConfig::SetIndex ( const int &  index )

inline

Set subsystem access flag.

Parameters

access

SetPsEndPoint()

void sup::syssup::common::SubsystemConfig::SetPsEndPoint ( const std::string &  ps_endpoint )

inline

Set subsystem Pub/Sub end point.

Parameters

ps_endpoint

SetRrEndPoint()

void sup::syssup::common::SubsystemConfig::SetRrEndPoint ( const std::string &  rr_endpoint )

inline

Set subsystem Req/Rep end point.

Parameters

rr_endpoint

SetScope()

void sup::syssup::common::SubsystemConfig::SetScope ( const ScopeEnum &  scope )

inline

Set subsystem scope.

Parameters

scope

scope enumeration

SetType()

void sup::syssup::common::SubsystemConfig::SetType ( const std::string &  type )

inline

Set subsystem type.

Parameters

type

---

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

• syssup/common/src/include/ifw/sup/syssup/common/config.hpp