#include <config.hpp>

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

Public Member Functions
	Config ()

bool	ParseOptions (int argc, char *argv[]) override

void	LoadConfig (const std::string &filename="", bool reset=false) override

virtual	~Config ()=default

const std::string	GetServerId () const override

const std::string	GetMsgReplierEndpoint () const override

const std::string	GetMsgPubEndpoint () const override

const timeval	GetDbTimeout () const override

const unsigned int	GetDbConnTimeout () const override

const unsigned int	GetDbTaskPeriod () const override

const std::string	GetSmScxmlFilename () const override

const std::string	GetConfigFilename () const override

const std::string	GetLogProperties () const override

const std::string	GetLogLevel () const override

const unsigned int	GetReqTout () const override
	Get the command timeout.

const unsigned int	GetMonTout () const override
	Get the wait timeout.

const std::string	GetOldbPrefix () const
	Get OLDB prefix.

const std::string	GetFitsPrefix () const
	Get FITS prefix.

const std::string	GetConfigAsString () const override
	Get the actual configuration as a string.

void	SetConfigAsString (const std::string &config) override
	Load a configuration as string.

std::string	GetResolvedFilename (const std::string &config)
	Resolve file name.

const elt::configng::CiiConfigInstanceNamespace &	GetInstance () const
	Merges an existing configuration with another config document.

ifw::core::dit::did::Did &	GetDid ()

virtual void	GetConfigList (DbVector &cfg_list)

CliConfig &	GetCliCfg ()

void	SetConfigFilename (const std::string cfg_file)

const std::string	GetVersion () const
	GetVersion.

Protected Member Functions
void	MergeConfig (const elt::configng::CiiConfigDocument &doc, bool check=true)
	Merges a configuration file.

void	CheckConfig (const elt::configng::CiiConfigDocument &doc) const
	Validates the document configuration.

Protected Attributes
std::unique_ptr< elt::configng::CiiConfigDocument >	m_config_doc
	Internal configuration document object.

CliConfig	m_cli_config
	Command line parameters.

boost::posix_time::ptime	m_file_utc

std::string	m_config_filename

ifw::core::dit::did::Did	m_did

log4cplus::Logger	m_logger

Detailed Description

This class provide access to the command line options and the configuration parameters stored in a configuration file.

It uses the new CII Config service.

The basic schema for the configuration is found in file definitions.yaml.

The supported command line parameters are:

Options: -h [ –help ] Print help messages -i [ –server-id ] arg Server ID -l [ –log-level ] arg Log level: ERROR, INFO, DEBUG, TRACE -p [ –log-prop-file ] arg Log property filename -c [ –config ] arg Configuration filename -r [ –req-endpoint ] arg Req/Rep endpoint (zpb.rr://<ipaddr>:<port>/) -d [ –db-endpoint ] arg Redis DB endpoint (<ipaddr>:<port>)

Constructor & Destructor Documentation

◆ Config()

ifw::core::utils::bat::Config::Config ( )

Default constructor.

Initialize application configuration attributes by

first use the default constant values defined in the header
override the constant values with environment variables (if defined)

◆ ~Config()

virtual ifw::core::utils::bat::Config::~Config ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ CheckConfig()

void ifw::core::utils::bat::Config::CheckConfig ( const elt::configng::CiiConfigDocument & doc ) const

protected

Validates the document configuration.

Parameters

doc	Config document object to be validated

Exceptions

std::runtime_error in case check reported issues.

◆ GetCliCfg()

CliConfig & ifw::core::utils::bat::Config::GetCliCfg ( )

Returns: A reference to the internal CliConfig object.

◆ GetConfigAsString()

const std::string ifw::core::utils::bat::Config::GetConfigAsString ( ) const

overridevirtual

Get the actual configuration as a string.

Implements ifw::core::utils::bat::IConfig.

◆ GetConfigFilename()

const std::string ifw::core::utils::bat::Config::GetConfigFilename ( ) const

overridevirtual

Returns: The application configuration filename.

Implements ifw::core::utils::bat::IConfig.

◆ GetConfigList()

void ifw::core::utils::bat::Config::GetConfigList ( DbVector & cfg_list )

virtual

◆ GetDbConnTimeout()

const unsigned int ifw::core::utils::bat::Config::GetDbConnTimeout ( ) const

overridevirtual

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

Implements ifw::core::utils::bat::IConfig.

◆ GetDbTaskPeriod()

const unsigned int ifw::core::utils::bat::Config::GetDbTaskPeriod ( ) const

overridevirtual

Returns: The period used by the DB worker thread.

Implements ifw::core::utils::bat::IConfig.

◆ GetDbTimeout()

const timeval ifw::core::utils::bat::Config::GetDbTimeout ( ) const

overridevirtual

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

Implements ifw::core::utils::bat::IConfig.

◆ GetDid()

ifw::core::dit::did::Did & ifw::core::utils::bat::Config::GetDid ( )

Returns: A reference to the Did interface object.

◆ GetFitsPrefix()

const std::string ifw::core::utils::bat::Config::GetFitsPrefix ( ) const

Get FITS prefix.

Returns

◆ GetInstance()

const elt::configng::CiiConfigInstanceNamespace & ifw::core::utils::bat::Config::GetInstance ( ) const

Merges an existing configuration with another config document.

Parameters

doc	Config document object to be merged
check	Flag to perform a check once is merged.

Exceptions

std::runtime_error in case merge reported issues.

Get object document instance

Returns: const instance of configuration documen object.

◆ GetLogLevel()

const std::string ifw::core::utils::bat::Config::GetLogLevel ( ) const

overridevirtual

Returns: The configured log level.

Implements ifw::core::utils::bat::IConfig.

◆ GetLogProperties()

const std::string ifw::core::utils::bat::Config::GetLogProperties ( ) const

overridevirtual

Returns: The application process name.

Implements ifw::core::utils::bat::IConfig.

◆ GetMonTout()

const unsigned int ifw::core::utils::bat::Config::GetMonTout ( ) const

overridevirtual

Get the wait timeout.

Returns

Implements ifw::core::utils::bat::IConfig.

◆ GetMsgPubEndpoint()

const std::string ifw::core::utils::bat::Config::GetMsgPubEndpoint ( ) const

overridevirtual

Returns: The network endpoint to publish internally within the application. The format is the CII URI For example: "zpb.rr://127.0.0.1:12081/AppCmds"

Implements ifw::core::utils::bat::IConfig.

◆ GetMsgReplierEndpoint()

const std::string ifw::core::utils::bat::Config::GetMsgReplierEndpoint ( ) const

overridevirtual

Returns: The network endpoint to send request to this application. The format is "\<protocol\>://\<ipaddr\>:\<port\>" where <protocol> is 'tcp' For example: "tcp://127.0.0.1:5577"

Implements ifw::core::utils::bat::IConfig.

◆ GetOldbPrefix()

const std::string ifw::core::utils::bat::Config::GetOldbPrefix ( ) const

Get OLDB prefix.

Returns

◆ GetReqTout()

const unsigned int ifw::core::utils::bat::Config::GetReqTout ( ) const

overridevirtual

Get the command timeout.

Returns

Implements ifw::core::utils::bat::IConfig.

◆ GetResolvedFilename()

std::string ifw::core::utils::bat::Config::GetResolvedFilename ( const std::string & config = "" )

Resolve file name.

Parameters

config Configurtion filename

Exceptions

standard exception if file cannot be found.

Returns: resolved filename

◆ GetServerId()

const std::string ifw::core::utils::bat::Config::GetServerId ( ) const

overridevirtual

Returns: return the server identifier

Implements ifw::core::utils::bat::IConfig.

◆ GetSmScxmlFilename()

const std::string ifw::core::utils::bat::Config::GetSmScxmlFilename ( ) const

overridevirtual

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

Implements ifw::core::utils::bat::IConfig.

◆ GetVersion()

const std::string ifw::core::utils::bat::Config::GetVersion ( ) const

GetVersion.

Returns

◆ LoadConfig()

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

overridevirtual

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.

Implements ifw::core::utils::bat::IConfig.

◆ MergeConfig()

void ifw::core::utils::bat::Config::MergeConfig	(	const elt::configng::CiiConfigDocument &	doc,
		bool	check = true )

protected

Merges a configuration file.

Parameters

doc	Config document object to be validated.
check	Flag to verify after the merge.

Exceptions

std::runtime_error in case check reported issues.

◆ ParseOptions()

bool ifw::core::utils::bat::Config::ParseOptions	(	int	argc,
		char *	argv[] )

overridevirtual

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.

Implements ifw::core::utils::bat::IConfig.

◆ SetConfigAsString()

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

overridevirtual

Load a configuration as string.

Parameters

config configuration as string to be loaded.

Implements ifw::core::utils::bat::IConfig.

◆ SetConfigFilename()

void ifw::core::utils::bat::Config::SetConfigFilename ( const std::string cfg_file )

Set the internal configuration filename.

Member Data Documentation

◆ m_cli_config

CliConfig ifw::core::utils::bat::Config::m_cli_config

protected

Command line parameters.

◆ m_config_doc

std::unique_ptr<elt::configng::CiiConfigDocument> ifw::core::utils::bat::Config::m_config_doc

protected

Internal configuration document object.

◆ m_config_filename

std::string ifw::core::utils::bat::Config::m_config_filename

protected

◆ m_did

ifw::core::dit::did::Did ifw::core::utils::bat::Config::m_did

protected

◆ m_file_utc

boost::posix_time::ptime ifw::core::utils::bat::Config::m_file_utc

protected

◆ m_logger

log4cplus::Logger ifw::core::utils::bat::Config::m_logger

protected

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

utils/bat/src/include/ifw/core/utils/bat/config.hpp
utils/bat/src/config.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Config()

◆ ~Config()

Member Function Documentation

◆ CheckConfig()

◆ GetCliCfg()

◆ GetConfigAsString()

◆ GetConfigFilename()

◆ GetConfigList()

◆ GetDbConnTimeout()

◆ GetDbTaskPeriod()

◆ GetDbTimeout()

◆ GetDid()

◆ GetFitsPrefix()

◆ GetInstance()

◆ GetLogLevel()

◆ GetLogProperties()

◆ GetMonTout()

◆ GetMsgPubEndpoint()

◆ GetMsgReplierEndpoint()

◆ GetOldbPrefix()

◆ GetReqTout()

◆ GetResolvedFilename()

◆ GetServerId()

◆ GetSmScxmlFilename()

◆ GetVersion()

◆ LoadConfig()

◆ MergeConfig()

◆ ParseOptions()

◆ SetConfigAsString()

◆ SetConfigFilename()

Member Data Documentation

◆ m_cli_config

◆ m_config_doc

◆ m_config_filename

◆ m_did

◆ m_file_utc

◆ m_logger