clarg Namespace Reference

Classes
class	arg_base
class	argBool
class	argDouble
class	argInt
class	args_container
class	argString
class	argT
class	container_manager

Functions
void	values (ostream &os, bool defined_only)
void	arguments_descriptions (ostream &os, string prefix, string suffix)
int	parse_arguments (int argc, char *argv[])
int	dump_arguments_to_file (ostream &of)
int	parse_arguments_from_file (std::istream &is)
int	parse_arguments_from_file (istream &is)

Variables
container_manager	cm

Function Documentation

arguments_descriptions()

void clarg::arguments_descriptions	(	ostream &	os,
		string	prefix,
		string	suffix
	)

Print the arguments descriptions. Very usefull when printing usage messages.

Definition at line 189 of file arglib.cpp.

References clarg::args_container::arguments_descriptions(), and clarg::container_manager::get_container().

Referenced by help(), main(), and usage().

dump_arguments_to_file()

int clarg::dump_arguments_to_file

(

ostream &

of

)

Dump the arguments to file. Returns 0 if ok, != 0 otherwise.

Definition at line 204 of file arglib.cpp.

References clarg::container_manager::get_container(), and clarg::args_container::list_arguments().

parse_arguments()

int clarg::parse_arguments	(	int	argc,
		char *	argv[]
	)

Parse the command line arguments. This must be called at the main. Returns 0 if ok, != 0 otherwise.

Definition at line 195 of file arglib.cpp.

References clarg::container_manager::get_container(), and clarg::args_container::parse_arguments().

Referenced by main().

parse_arguments_from_file() [1/2]

int clarg::parse_arguments_from_file

(

istream &

is

)

Read the arguments from file. Returns 0 if ok, != 0 otherwise.

parse_arguments_from_file() [2/2]

int clarg::parse_arguments_from_file

(

std::istream &

is

)

Read the arguments from file. Returns 0 if ok, != 0 otherwise.

Definition at line 215 of file arglib.cpp.

References clarg::container_manager::get_container(), and clarg::args_container::parse_arguments_from_file().

values()

void clarg::values	(	ostream &	os,
		bool	defined_only = true
	)

Print the arguments values. If defined_only is true, only the arguments set at the command line are printed.

Definition at line 183 of file arglib.cpp.

References clarg::container_manager::get_container(), and clarg::args_container::list_arguments().

Referenced by main().

Variable Documentation

cm

container_manager clarg::cm

Definition at line 173 of file arglib.cpp.