famouso::util Namespace Reference

Namespaces
namespace	impl
Data Structures
class	Delegate
	Implements anonymous callback functionality. More...
class	Delegate< void >
Typedefs
typedef boost::program_options::options_description	CommandLineParameter_type
	This is option_description type.
typedef boost::details::pool::singleton_default < CommandLineParameter_type >	cmdline_options
	The cmdline_option is a singleton providing the interface to the command line parameter framework. It is used to put new options into the general description enabling to add options from different components in a coherent way. All components use this to summarize the options in one place.
typedef boost::program_options::variables_map	vm_type
	This type describes the map, where the command line parameter are parsed into.
typedef boost::details::pool::singleton_default < vm_type >	vm
	The vm is the interface to the parsed command line parameters. It is realized as a singleton allowing access from different places/components always to the same instance of the parsed parameter.
typedef boost::asio::io_service	ios_type
typedef boost::details::pool::singleton_default < ios_type >	ios
Functions
void	clp (int ac, char **av)
	The famouso::util::clp function is the interface to the command line parameter framework. This function is called within the famouso::init(int argc, char **argv) method in order to parse the given parameter and deploy it to the respective components.

---

Typedef Documentation

typedef boost::details::pool::singleton_default<CommandLineParameter_type> famouso::util::cmdline_options

The cmdline_option is a singleton providing the interface to the command line parameter framework. It is used to put new options into the general description enabling to add options from different components in a coherent way. All components use this to summarize the options in one place.

typedef boost::program_options::options_description famouso::util::CommandLineParameter_type

This is option_description type.

typedef boost::details::pool::singleton_default<ios_type> famouso::util::ios

typedef boost::asio::io_service famouso::util::ios_type

typedef boost::details::pool::singleton_default<vm_type> famouso::util::vm

The vm is the interface to the parsed command line parameters. It is realized as a singleton allowing access from different places/components always to the same instance of the parsed parameter.

typedef boost::program_options::variables_map famouso::util::vm_type

This type describes the map, where the command line parameter are parsed into.

---

Function Documentation

void famouso::util::clp	(	int	ac,
		char **	av
	)

The famouso::util::clp function is the interface to the command line parameter framework. This function is called within the famouso::init(int argc, char **argv) method in order to parse the given parameter and deploy it to the respective components.

Parameters:

[in]	ac	is the number of parameters given
[in]	av	is an array of char* containing at each entry a parameter and the array is parsed

Referenced by famouso::init().