#include <ConfigChecker.h>

Inheritance diagram for alize::ConfigChecker:

Collaboration diagram for alize::ConfigChecker:

Classes
class	Param
	Internal class. Do not use. More...
Public Member Functions
	ConfigChecker ()
virtual	~ConfigChecker ()
void	check (const Config &c)
String	getParamList ()
void	addIntegerParam (const String &name, bool mandatory, bool argIsRequired, const String &desc="")
void	addFloatParam (const String &name, bool mandatory, bool argIsRequired, const String &desc="")
void	addBooleanParam (const String &name, bool mandatory, bool argIsRequired, const String &desc="")
void	addStringParam (const String &name, bool mandatory, bool argIsRequired, const String &desc="")
virtual String	getClassName () const
Private Member Functions
void	err (const String &e) const
void	checkName (const String &name) const
	ConfigChecker (const ConfigChecker &)
const ConfigChecker &	operator= (const ConfigChecker &c)
bool	operator== (const ConfigChecker &c) const
bool	operator!= (const ConfigChecker &c) const
Private Attributes
RefVector< Param >	_vect
Friends
class	TestConfigChecker

Detailed Description

Class for validating parameters of a configuration object.

Author:: Frederic Wils frederic.wils@lia.univ-avignon.fr

Version:: 1.0

Date:: 2005

Definition at line 82 of file ConfigChecker.h.

Constructor & Destructor Documentation

CC::ConfigChecker ( )

Definition at line 67 of file ConfigChecker.cpp.

CC::~ConfigChecker ( ) [virtual]

Definition at line 229 of file ConfigChecker.cpp.

alize::ConfigChecker::ConfigChecker ( const ConfigChecker & ) [private]

Member Function Documentation

void CC::addBooleanParam	(	const String &	name,
		bool	mandatory,
		bool	argIsRequired,
		const String &	desc = `""`
	)

Adds a boolean parameter

Parameters:

name	name of the parameter
mandatory	true if option is mandatory in the config; false otherwise
argIsRequired	true if argument is mandatory for this option; false otherwise
desc	description. Useful for --help

Exceptions:

Exception throw if name is empty

Definition at line 165 of file ConfigChecker.cpp.

References alize::ConfigChecker::Param::argIsRequired, alize::ConfigChecker::Param::description, alize::ConfigChecker::Param::mandatory, alize::ConfigChecker::Param::name, alize::PARAMTYPE_BOOLEAN, and alize::ConfigChecker::Param::type.

void CC::addFloatParam	(	const String &	name,
		bool	mandatory,
		bool	argIsRequired,
		const String &	desc = `""`
	)

Adds a float parameter

Parameters:

name	name of the parameter
mandatory	true if option is mandatory in the config; false otherwise
argIsRequired	true if argument is mandatory for this option; false otherwise
desc	description. Useful for --help

Exceptions:

Exception throw if name is empty

Definition at line 151 of file ConfigChecker.cpp.

References alize::ConfigChecker::Param::argIsRequired, alize::ConfigChecker::Param::description, alize::ConfigChecker::Param::mandatory, alize::ConfigChecker::Param::name, alize::PARAMTYPE_FLOAT, and alize::ConfigChecker::Param::type.

void CC::addIntegerParam	(	const String &	name,
		bool	mandatory,
		bool	argIsRequired,
		const String &	desc = `""`
	)

Adds an integer parameter

Parameters:

name	name of the parameter
mandatory	true if option is mandatory in the config; false otherwise
argIsRequired	true if argument is mandatory for this option; false otherwise
desc	description. Useful for --help

Exceptions:

Exception throw if name is empty

Definition at line 137 of file ConfigChecker.cpp.

References alize::ConfigChecker::Param::argIsRequired, alize::ConfigChecker::Param::description, alize::ConfigChecker::Param::mandatory, alize::ConfigChecker::Param::name, alize::PARAMTYPE_INTEGER, and alize::ConfigChecker::Param::type.

void CC::addStringParam	(	const String &	name,
		bool	mandatory,
		bool	argIsRequired,
		const String &	desc = `""`
	)

Adds a string parameter

Parameters:

name	name of the parameter
mandatory	true if option is mandatory in the config; false otherwise
argIsRequired	true if argument is mandatory for this option; false otherwise
desc	description. Useful for --help

Exceptions:

Exception throw if name is empty

Definition at line 179 of file ConfigChecker.cpp.

References alize::ConfigChecker::Param::argIsRequired, alize::ConfigChecker::Param::description, alize::ConfigChecker::Param::mandatory, alize::ConfigChecker::Param::name, alize::PARAMTYPE_STRING, and alize::ConfigChecker::Param::type.

void CC::check ( const Config & c )

Checks a configuration

Exceptions:

ConfigCheckException thrown if check fail

Parameters: