#include <iConfig.hpp>

Inheritance diagram for sup::syssup::common::IConfig:

Public Member Functions
virtual bool	ParseOptions (int argc, char *argv[])=0

virtual void	LoadConfig (const std::string &filename="")=0

virtual const std::string	GetServerId () const =0

virtual const std::string	GetMsgReplierEndpoint () const =0

virtual const std::string	GetDbEndpoint () const =0

virtual const std::string	GetMsgPubEndpoint () const =0

virtual const timeval	GetDbTimeout () const =0

virtual const std::string	GetSmScxmlFilename () const =0

virtual const std::string	GetConfigFilename () const =0

virtual const std::string	GetProcName () const =0

virtual const std::string	GetLogLevel () const =0

virtual const int	GetNumSubsystems ()=0
	GetNumSubsyss. More...

virtual const std::string	GetSubsysName (const int &subsysIndex)=0
	GetSubsysName. More...

virtual const std::string	GetSubsysType (const std::string &name)=0
	GetSubsysType. More...

virtual std::optional< ScopeEnum >	GetSubsysScope (const std::string &name)=0
	GetSubsysScope. More...

virtual bool	GetSubsysAccess (const std::string &name)=0
	GetSubsysAccess. More...

virtual const unsigned int	GetWaitTout ()=0
	GetWaitTout. More...

virtual const unsigned int	GetCmdTout ()=0
	GetCmdTout. More...

virtual void	GetConfigList (std::vector< std::string > &cfg_list)=0
	Get configuration list. More...

virtual const std::string	GetConfigAsString () const =0
	Get the actual configuration as a string. More...

Detailed Description

The IConfig is the abstract Config class that descrive the behaviour of the Config class. It is the base class for any supervisor configuration class.

Member Function Documentation

◆ GetCmdTout()

virtual const unsigned int sup::syssup::common::IConfig::GetCmdTout ( )

pure virtual

GetCmdTout.

Returns

Implemented in sup::syssup::common::Config.

◆ GetConfigAsString()

virtual const std::string sup::syssup::common::IConfig::GetConfigAsString ( ) const

pure virtual

Get the actual configuration as a string.

Implemented in sup::syssup::common::Config.

◆ GetConfigFilename()

virtual const std::string sup::syssup::common::IConfig::GetConfigFilename ( ) const

pure virtual

Returns: The application configuration filename.

Implemented in sup::syssup::common::Config.

◆ GetConfigList()

virtual void sup::syssup::common::IConfig::GetConfigList ( std::vector< std::string > & cfg_list )

pure virtual

Get configuration list.

Parameters

cfg_list List of all configuration parameters.

This method returs the complete of configuration parameters handled by this class. This method is used to dump the list into the DB.

Implemented in sup::syssup::common::Config.

◆ GetDbEndpoint()

virtual const std::string sup::syssup::common::IConfig::GetDbEndpoint ( ) const

pure virtual

Returns: The IP address and port used to connect to the runtime DB.

Implemented in sup::syssup::common::Config.

◆ GetDbTimeout()

virtual const timeval sup::syssup::common::IConfig::GetDbTimeout ( ) const

pure virtual

Returns: The timeout used when communicating to the runtime DB.

Implemented in sup::syssup::common::Config.

◆ GetLogLevel()

virtual const std::string sup::syssup::common::IConfig::GetLogLevel ( ) const

pure virtual

Returns: The configured log level.

Implemented in sup::syssup::common::Config.

◆ GetMsgPubEndpoint()

virtual const std::string sup::syssup::common::IConfig::GetMsgPubEndpoint ( ) const

pure virtual

Returns: The network endpoint to publish internally within this application.

Implemented in sup::syssup::common::Config.

◆ GetMsgReplierEndpoint()

virtual const std::string sup::syssup::common::IConfig::GetMsgReplierEndpoint ( ) const

pure virtual

Returns: The network endpoint to send request to this application.

Implemented in sup::syssup::common::Config.

◆ GetNumSubsystems()

virtual const int sup::syssup::common::IConfig::GetNumSubsystems ( )

pure virtual

GetNumSubsyss.

Returns

Implemented in sup::syssup::common::Config.

◆ GetProcName()

virtual const std::string sup::syssup::common::IConfig::GetProcName ( ) const

pure virtual

Returns: The application process name.

Implemented in sup::syssup::common::Config.

◆ GetServerId()

virtual const std::string sup::syssup::common::IConfig::GetServerId ( ) const

pure virtual

Returns: return the server identifier

Implemented in sup::syssup::common::Config.

◆ GetSmScxmlFilename()

virtual const std::string sup::syssup::common::IConfig::GetSmScxmlFilename ( ) const

pure virtual

Returns: The SCXML State Machine model filename used by the application.

Implemented in sup::syssup::common::Config.

◆ GetSubsysAccess()

virtual bool sup::syssup::common::IConfig::GetSubsysAccess ( const std::string & name )

pure virtual

GetSubsysAccess.

Parameters

name

Returns

Implemented in sup::syssup::common::Config.

◆ GetSubsysName()

virtual const std::string sup::syssup::common::IConfig::GetSubsysName ( const int & subsysIndex )

pure virtual

GetSubsysName.

Parameters

subsysIndex

Returns

Implemented in sup::syssup::common::Config.

◆ GetSubsysScope()

virtual std::optional<ScopeEnum> sup::syssup::common::IConfig::GetSubsysScope ( const std::string & name )

pure virtual

GetSubsysScope.

Parameters

name	Name of the subsystem

Returns

Implemented in sup::syssup::common::Config.

◆ GetSubsysType()

virtual const std::string sup::syssup::common::IConfig::GetSubsysType ( const std::string & name )

pure virtual

GetSubsysType.

Parameters

name

Returns

Implemented in sup::syssup::common::Config.

◆ GetWaitTout()

virtual const unsigned int sup::syssup::common::IConfig::GetWaitTout ( )

pure virtual

GetWaitTout.

Returns

Implemented in sup::syssup::common::Config.

◆ LoadConfig()

virtual void sup::syssup::common::IConfig::LoadConfig ( const std::string & filename = "" )

pure virtual

This method load from a configuration file the application configuration overriding the initialization done in the constructor and the command line options.

Parameters

[in] filename Application configuration filename.

Implemented in sup::syssup::common::Config.

◆ ParseOptions()

virtual bool sup::syssup::common::IConfig::ParseOptions	(	int	argc,
		char *	argv[]
	)

pure virtual

This method parses the command line parameters overriding the initialization done in the constructor.

Parameters

[in]	argc	Number of command line options.
[in]	argv	Pointer to the array of command line options.

Returns: false if the help option has been invoked, true otherwise.

Implemented in sup::syssup::common::Config.

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

syssup/common/src/include/sup/syssup/common/iConfig.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetCmdTout()

◆ GetConfigAsString()

◆ GetConfigFilename()

◆ GetConfigList()

◆ GetDbEndpoint()

◆ GetDbTimeout()

◆ GetLogLevel()

◆ GetMsgPubEndpoint()

◆ GetMsgReplierEndpoint()

◆ GetNumSubsystems()

◆ GetProcName()

◆ GetServerId()

◆ GetSmScxmlFilename()

◆ GetSubsysAccess()

◆ GetSubsysName()

◆ GetSubsysScope()

◆ GetSubsysType()

◆ GetWaitTout()

◆ LoadConfig()

◆ ParseOptions()