sup::subsim::common::IConfig Class Reference

#include <iConfig.hpp>

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	GetPubEndpoint () 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 std::optional< bool >	GetReplyOk (const std::string &name) const =0
virtual std::optional< int >	GetReplyDelay (const std::string &name) const =0
virtual std::optional< std::string >	GetReplyErrorMessage (const std::string &name) const =0
virtual ReplyConfigData *	GetCmdReplyData (const std::string &name)=0
virtual const unsigned int	GetReqTout ()=0
	GetReqTout. More...
virtual const int	GetNumCommands ()=0
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...
virtual void	SetReplyOk (const std::string &name, const bool &flag)=0
virtual void	SetReplyDelay (const std::string &name, const int &delay)=0
virtual void	SetReplyErrorMessage (const std::string &name, const std::string &msg)=0

Member Function Documentation

GetCmdReplyData()

virtual ReplyConfigData* sup::subsim::common::IConfig::GetCmdReplyData ( const std::string &  name )

pure virtual

GetConfigAsString()

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

pure virtual

Get the actual configuration as a string.

GetConfigFilename()

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

pure virtual

Returns

The application configuration filename.

GetConfigList()

virtual void sup::subsim::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.

GetDbEndpoint()

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

pure virtual

Returns

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

GetDbTimeout()

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

pure virtual

Returns

The timeout used when communicating to the runtime DB.

GetLogLevel()

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

pure virtual

Returns

The configured log level.

GetMsgReplierEndpoint()

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

pure virtual

Returns

The network endpoint to send request to this application.

GetNumCommands()

virtual const int sup::subsim::common::IConfig::GetNumCommands ( )

pure virtual

GetProcName()

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

pure virtual

Returns

The application process name.

GetPubEndpoint()

virtual const std::string sup::subsim::common::IConfig::GetPubEndpoint ( ) const

pure virtual

Returns

The network endpoint to publish internally within this application.

GetReplyDelay()

virtual std::optional<int> sup::subsim::common::IConfig::GetReplyDelay ( const std::string &  name ) const

pure virtual

GetReplyErrorMessage()

virtual std::optional<std::string> sup::subsim::common::IConfig::GetReplyErrorMessage ( const std::string &  name ) const

pure virtual

GetReplyOk()

virtual std::optional<bool> sup::subsim::common::IConfig::GetReplyOk ( const std::string &  name ) const

pure virtual

GetReqTout()

virtual const unsigned int sup::subsim::common::IConfig::GetReqTout ( )

pure virtual

GetReqTout.

Returns

GetServerId()

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

pure virtual

Returns

return the server identifier

GetSmScxmlFilename()

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

pure virtual

Returns

The SCXML State Machine model filename used by the application.

LoadConfig()

virtual void sup::subsim::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.

ParseOptions()

virtual bool sup::subsim::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.

SetReplyDelay()

virtual void sup::subsim::common::IConfig::SetReplyDelay ( const std::string &  name, const int &  delay  )

pure virtual

SetReplyErrorMessage()

virtual void sup::subsim::common::IConfig::SetReplyErrorMessage ( const std::string &  name, const std::string &  msg  )

pure virtual

SetReplyOk()

virtual void sup::subsim::common::IConfig::SetReplyOk ( const std::string &  name, const bool &  flag  )

pure virtual

---

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

• subsim/common/src/include/ifw/sup/subsim/common/iConfig.hpp