ifw::core::utils::bat::IConfig Class Reference

#include <iConfig.hpp>

Inheritance diagram for ifw::core::utils::bat::IConfig:

Public Member Functions
virtual bool	ParseOptions (int argc, char *argv[])=0
virtual void	LoadConfig (const std::string &filename="", bool reset=false)=0
virtual const std::string	GetServerId () const =0
virtual const std::string	GetMsgReplierEndpoint () const =0
virtual const std::string	GetMsgPubEndpoint () const =0
virtual const timeval	GetDbTimeout () const =0
virtual const unsigned int	GetDbConnTimeout () const =0
virtual const unsigned int	GetDbTaskPeriod () const =0
virtual const std::string	GetSmScxmlFilename () const =0
virtual const std::string	GetConfigFilename () const =0
virtual const std::string	GetLogProperties () const =0
virtual const std::string	GetLogLevel () const =0
virtual const unsigned int	GetMonTout () const =0
	GetMonTout.
virtual const unsigned int	GetReqTout () const =0
	GetReqTout.
virtual const std::string	GetConfigAsString () const =0
	Get the actual configuration as a string.
virtual void	SetConfigAsString (const std::string &config)=0

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

GetConfigAsString()

virtual const std::string ifw::core::utils::bat::IConfig::GetConfigAsString ( ) const

pure virtual

Get the actual configuration as a string.

Implemented in ifw::core::utils::bat::Config.

GetConfigFilename()

virtual const std::string ifw::core::utils::bat::IConfig::GetConfigFilename ( ) const

pure virtual

Returns

The application configuration filename.

Implemented in ifw::core::utils::bat::Config.

GetDbConnTimeout()

virtual const unsigned int ifw::core::utils::bat::IConfig::GetDbConnTimeout ( ) const

pure virtual

Returns

The timeout used when communicating to the runtime DB.

Implemented in ifw::core::utils::bat::Config.

GetDbTaskPeriod()

virtual const unsigned int ifw::core::utils::bat::IConfig::GetDbTaskPeriod ( ) const

pure virtual

Returns

The period used by the DB worker thread.

Implemented in ifw::core::utils::bat::Config.

GetDbTimeout()

virtual const timeval ifw::core::utils::bat::IConfig::GetDbTimeout ( ) const

pure virtual

Returns

The timeout used when communicating to the runtime DB.

Implemented in ifw::core::utils::bat::Config.

GetLogLevel()

virtual const std::string ifw::core::utils::bat::IConfig::GetLogLevel ( ) const

pure virtual

Returns

The configured log level.

Implemented in ifw::core::utils::bat::Config.

GetLogProperties()

virtual const std::string ifw::core::utils::bat::IConfig::GetLogProperties ( ) const

pure virtual

Returns

The application process name.

Implemented in ifw::core::utils::bat::Config.

GetMonTout()

virtual const unsigned int ifw::core::utils::bat::IConfig::GetMonTout ( ) const

pure virtual

GetMonTout.

Returns

Implemented in ifw::core::utils::bat::Config.

GetMsgPubEndpoint()

virtual const std::string ifw::core::utils::bat::IConfig::GetMsgPubEndpoint ( ) const

pure virtual

Returns

The network endpoint to publish internally within this application.

Implemented in ifw::core::utils::bat::Config.

GetMsgReplierEndpoint()

virtual const std::string ifw::core::utils::bat::IConfig::GetMsgReplierEndpoint ( ) const

pure virtual

Returns

The network endpoint to send request to this application.

Implemented in ifw::core::utils::bat::Config.

GetReqTout()

virtual const unsigned int ifw::core::utils::bat::IConfig::GetReqTout ( ) const

pure virtual

GetReqTout.

Returns

Implemented in ifw::core::utils::bat::Config.

GetServerId()

virtual const std::string ifw::core::utils::bat::IConfig::GetServerId ( ) const

pure virtual

Returns

return the server identifier

Implemented in ifw::core::utils::bat::Config.

GetSmScxmlFilename()

virtual const std::string ifw::core::utils::bat::IConfig::GetSmScxmlFilename ( ) const

pure virtual

Returns

The SCXML State Machine model filename used by the application.

Implemented in ifw::core::utils::bat::Config.

LoadConfig()

virtual void ifw::core::utils::bat::IConfig::LoadConfig ( const std::string & filename = "", bool reset = false )

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 ifw::core::utils::bat::Config.

ParseOptions()

virtual bool ifw::core::utils::bat::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 ifw::core::utils::bat::Config.

SetConfigAsString()

virtual void ifw::core::utils::bat::IConfig::SetConfigAsString ( const std::string & config )

pure virtual

Implemented in ifw::core::utils::bat::Config.

---

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

• utils/bat/src/include/ifw/core/utils/bat/iConfig.hpp