hellomal::Config Class Reference

#include <config.hpp>

Public Member Functions
	Config ()
virtual	~Config ()
bool	ParseOptions (int argc, char *argv[])
void	LoadConfig (const std::string &filename="")
const std::string &	GetMsgReplierEndpoint () const
const std::string &	GetDbEndpoint () const
const timeval	GetDbTimeout () const
const std::string &	GetSmScxmlFilename () const
const std::string &	GetConfigFilename () const
const std::string &	GetProcName () const
const std::string &	GetLogLevel () const
const std::string &	GetLogProperties () const
	Config (const Config &)=delete
Config &	operator= (const Config &)=delete
	Disable copy constructor. More...
	Config ()
virtual	~Config ()
bool	ParseOptions (int argc, char *argv[])
void	LoadConfig (const std::string &filename="")
const std::string &	GetMsgReplierEndpoint () const
const std::string &	GetDbEndpoint () const
const timeval	GetDbTimeout () const
const std::string &	GetSmScxmlFilename () const
const std::string &	GetConfigFilename () const
const std::string &	GetProcName () const
const std::string &	GetLogLevel () const
const std::string &	GetLogProperties () const
	Config (const Config &)=delete
Config &	operator= (const Config &)=delete
	Disable copy constructor. More...

Detailed Description

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

Constructor & Destructor Documentation

hellomal::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)

hellomal::Config::~Config ( )

virtual

Default destructor.

hellomal::Config::Config ( const Config &  )

delete

hellomal::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)

virtual hellomal::Config::~Config ( )

virtual

Default destructor.

hellomal::Config::Config ( const Config &  )

delete

Member Function Documentation

const std::string & hellomal::Config::GetConfigFilename

(

)

const

Returns

The application configuration filename.

const std::string& hellomal::Config::GetConfigFilename

(

)

const

Returns

The application configuration filename.

const std::string & hellomal::Config::GetDbEndpoint

(

)

const

Returns

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

const std::string& hellomal::Config::GetDbEndpoint

(

)

const

Returns

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

const timeval hellomal::Config::GetDbTimeout

(

)

const

Returns

The timeout used when communicating to the runtime DB.

const timeval hellomal::Config::GetDbTimeout

(

)

const

Returns

The timeout used when communicating to the runtime DB.

const std::string & hellomal::Config::GetLogLevel

(

)

const

Returns

The configured log level.

const std::string& hellomal::Config::GetLogLevel

(

)

const

Returns

The configured log level.

const std::string & hellomal::Config::GetLogProperties

(

)

const

Returns

The log properties config filename.

const std::string& hellomal::Config::GetLogProperties

(

)

const

Returns

The log properties config filename.

const std::string& hellomal::Config::GetMsgReplierEndpoint

(

)

const

Returns

The network endpoint to send request to this application. The format is "<middleware>.<protocol>://<ipaddr>:<port>". For example: "zpb.rr://127.0.0.1:12081/"

const std::string & hellomal::Config::GetMsgReplierEndpoint

(

)

const

Returns

The network endpoint to send request to this application. The format is "<middleware>.<protocol>://<ipaddr>:<port>". For example: "zpb.rr://127.0.0.1:12081/"

const std::string& hellomal::Config::GetProcName

(

)

const

Returns

The application process name.

const std::string & hellomal::Config::GetProcName

(

)

const

Returns

The application process name.

const std::string& hellomal::Config::GetSmScxmlFilename

(

)

const

Returns

The SCXML State Machine model filename used by the application.

const std::string & hellomal::Config::GetSmScxmlFilename

(

)

const

Returns

The SCXML State Machine model filename used by the application.

void hellomal::Config::LoadConfig

(

const std::string &

filename = ""

)

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.

void hellomal::Config::LoadConfig

(

const std::string &

filename = ""

)

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.

Config& hellomal::Config::operator= ( const Config &  )

delete

Disable copy constructor.

Config& hellomal::Config::operator= ( const Config &  )

delete

Disable copy constructor.

bool hellomal::Config::ParseOptions	(	int	argc,
		char *	argv[]
	)

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.

bool hellomal::Config::ParseOptions	(	int	argc,
		char *	argv[]
	)

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.

---

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

• INTROOT/sources/hellomal/src/config.hpp
• test/templates/genMalSm/hello/hellomal/src/config.hpp
• INTROOT/sources/hellomal/src/config.cpp
• test/templates/genMalSm/hello/hellomal/src/config.cpp