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

#include <config.hpp>

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

Protected Attributes
ScopeEnum	m_scope {ScopeEnum::INTERNAL}
	actual subsystem scope. More...
std::string	m_type {"Generic"}
	actual subsystem class type. More...
std::string	m_rr_endpoint {""}
	actual subsystem rr endpoint. More...
std::string	m_ps_endpoint {""}
	actual subsystem ps endpoint. More...
bool	m_access {false}
	actual subsystem access flag. More...

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

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 ( 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 ( bool  access )

inline

Set subsystem access flag.

Parameters

access

SetPsEndPoint()

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

inline

Set subsystem Pub/Sub end point.

Parameters

ps_endpoint

SetRrEndPoint()

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

inline

Set subsystem Req/Rep end point.

Parameters

rr_endpoint

SetScope()

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

inline

Set subsystem scope.

Parameters

scope

scope enumeration

SetType()

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

inline

Set subsystem type.

Parameters

type

Member Data Documentation

m_access

bool sup::syssup::common::SubsystemConfig::m_access {false}

protected

actual subsystem access flag.

m_ps_endpoint

std::string sup::syssup::common::SubsystemConfig::m_ps_endpoint {""}

protected

actual subsystem ps endpoint.

m_rr_endpoint

std::string sup::syssup::common::SubsystemConfig::m_rr_endpoint {""}

protected

actual subsystem rr endpoint.

m_scope

ScopeEnum sup::syssup::common::SubsystemConfig::m_scope {ScopeEnum::INTERNAL}

protected

actual subsystem scope.

m_type

std::string sup::syssup::common::SubsystemConfig::m_type {"Generic"}

protected

actual subsystem class type.

---

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

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