ifw-fcf  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
fcf::devmgr::common::IConfig Class Referenceabstract

#include <iConfig.hpp>

Inheritance diagram for fcf::devmgr::common::IConfig:
fcf::devmgr::common::Config MockIConfig

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 const std::string GetFitsPrefix () const =0
 Get FITS prefix. More...
 
virtual const int GetNumDevices ()=0
 GetNumDevices. More...
 
virtual const std::string GetDeviceName (const int &deviceIndex)=0
 GetDeviceName. More...
 
virtual const std::string GetDeviceFile (const std::string &name)=0
 GetDeviceFile. More...
 
virtual const std::string GetDeviceType (const std::string &name)=0
 GetDeviceType. More...
 
virtual const unsigned int GetCmdTout ()=0
 GetCmdTout. More...
 
virtual dit::did::Did & GetDid ()=0
 
virtual void GetConfigList (std::vector< std::string > &cfg_list)=0
 Get configuration list. More...
 

Member Function Documentation

virtual const unsigned int fcf::devmgr::common::IConfig::GetCmdTout ( )
pure virtual

GetCmdTout.

Returns

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetConfigFilename ( ) const
pure virtual
Returns
The application configuration filename.

Implemented in fcf::devmgr::common::Config.

virtual void fcf::devmgr::common::IConfig::GetConfigList ( std::vector< std::string > &  cfg_list)
pure virtual

Get configuration list.

Parameters
cfg_listList 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 fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetDbEndpoint ( ) const
pure virtual
Returns
The IP address and port used to connect to the runtime DB.

Implemented in fcf::devmgr::common::Config.

virtual const timeval fcf::devmgr::common::IConfig::GetDbTimeout ( ) const
pure virtual
Returns
The timeout used when communicating to the runtime DB.

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetDeviceFile ( const std::string &  name)
pure virtual

GetDeviceFile.

Parameters
name
Returns

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetDeviceName ( const int &  deviceIndex)
pure virtual

GetDeviceName.

Parameters
deviceIndex
Returns

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetDeviceType ( const std::string &  name)
pure virtual

GetDeviceType.

Parameters
name
Returns

Implemented in fcf::devmgr::common::Config.

virtual dit::did::Did& fcf::devmgr::common::IConfig::GetDid ( )
pure virtual
Returns
A reference to the Did interface object.

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetFitsPrefix ( ) const
pure virtual

Get FITS prefix.

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetLogLevel ( ) const
pure virtual
Returns
The configured log level.

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetMsgReplierEndpoint ( ) const
pure virtual
Returns
The network endpoint to send request to this application.

Implemented in fcf::devmgr::common::Config.

virtual const int fcf::devmgr::common::IConfig::GetNumDevices ( )
pure virtual

GetNumDevices.

Returns

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetProcName ( ) const
pure virtual
Returns
The application process name.

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetPubEndpoint ( ) const
pure virtual
Returns
The network endpoint to publish internally within this application.

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetServerId ( ) const
pure virtual
Returns
return the server identifier

Implemented in fcf::devmgr::common::Config.

virtual const std::string fcf::devmgr::common::IConfig::GetSmScxmlFilename ( ) const
pure virtual
Returns
The SCXML State Machine model filename used by the application.

Implemented in fcf::devmgr::common::Config.

virtual void fcf::devmgr::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]filenameApplication configuration filename.

Implemented in fcf::devmgr::common::Config.

virtual bool fcf::devmgr::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]argcNumber of command line options.
[in]argvPointer to the array of command line options.
Returns
false if the help option has been invoked, true otherwise.

Implemented in fcf::devmgr::common::Config.


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