#include <Parameters.h>

Public Member Functions
	Parameters ()

	~Parameters ()

RETCODE	paramsetSetToDefault ()

RETCODE	paramSetToDefault (PARAM *param)

void	paramsetRead (const char *filename)

RETCODE	paramsetWrite (const char *filename, bool comments, bool onlychanged)

RETCODE	paramsetAddBool (const char name, const char desc, Bool valueptr, Bool isadvanced, Bool defaultvalue, PARAMDATA paramdata)

RETCODE	paramsetAddInt (const char name, const char desc, Int valueptr, Bool isadvanced, Int defaultvalue, Int minvalue, Int maxvalue, PARAMDATA paramdata)

RETCODE	paramsetAddShortint (const char name, const char desc, Shortint valueptr, Bool isadvanced, Shortint defaultvalue, Shortint minvalue, Shortint maxvalue, PARAMDATA paramdata)

RETCODE	paramsetAddLongint (const char name, const char desc, Longint valueptr, Bool isadvanced, Longint defaultvalue, Longint minvalue, Longint maxvalue, PARAMDATA paramdata)

RETCODE	paramsetAddReal (const char name, const char desc, Real valueptr, Bool isadvanced, Real defaultvalue, Real minvalue, Real maxvalue, PARAMDATA paramdata)

RETCODE	paramsetAddChar (const char name, const char desc, char valueptr, Bool isadvanced, char defaultvalue, const char allowedvalues, PARAMDATA *paramdata)

RETCODE	paramsetAddString (const char name, const char desc, char *valueptr, Bool isadvanced, const char defaultvalue, PARAMDATA *paramdata)

Public Attributes
std::map< const char , PARAM , strCmp >	paramset

Detailed Description

Definition at line 139 of file Parameters.h.

Constructor & Destructor Documentation

Parameters::Parameters ( )

inline

Definition at line 143 of file Parameters.h.

Parameters::~Parameters ( )

inline

Definition at line 147 of file Parameters.h.

Member Function Documentation

RETCODE Parameters::paramsetAddBool	(	const char *	name,
		const char *	desc,
		Bool *	valueptr,
		Bool	isadvanced,
		Bool	defaultvalue,
		PARAMDATA *	paramdata
	)

creates a bool parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
paramdata	locally defined parameter specific data

RETCODE Parameters::paramsetAddChar	(	const char *	name,
		const char *	desc,
		char *	valueptr,
		Bool	isadvanced,
		char	defaultvalue,
		const char *	allowedvalues,
		PARAMDATA *	paramdata
	)

creates a char parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
allowedvalues	array with possible parameter values, or NULL if not restricted
paramdata	locally defined parameter specific data

RETCODE Parameters::paramsetAddInt	(	const char *	name,
		const char *	desc,
		Int *	valueptr,
		Bool	isadvanced,
		Int	defaultvalue,
		Int	minvalue,
		Int	maxvalue,
		PARAMDATA *	paramdata
	)

creates a int parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

RETCODE Parameters::paramsetAddLongint	(	const char *	name,
		const char *	desc,
		Longint *	valueptr,
		Bool	isadvanced,
		Longint	defaultvalue,
		Longint	minvalue,
		Longint	maxvalue,
		PARAMDATA *	paramdata
	)

creates a Longint parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

RETCODE Parameters::paramsetAddReal	(	const char *	name,
		const char *	desc,
		Real *	valueptr,
		Bool	isadvanced,
		Real	defaultvalue,
		Real	minvalue,
		Real	maxvalue,
		PARAMDATA *	paramdata
	)

creates a Real parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

RETCODE Parameters::paramsetAddShortint	(	const char *	name,
		const char *	desc,
		Shortint *	valueptr,
		Bool	isadvanced,
		Shortint	defaultvalue,
		Shortint	minvalue,
		Shortint	maxvalue,
		PARAMDATA *	paramdata
	)

creates a int parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
minvalue	minimum value for parameter
maxvalue	maximum value for parameter
paramdata	locally defined parameter specific data

RETCODE Parameters::paramsetAddString	(	const char *	name,
		const char *	desc,
		char **	valueptr,
		Bool	isadvanced,
		const char *	defaultvalue,
		PARAMDATA *	paramdata
	)

creates a string parameter, sets it to its default value, and adds it to the parameter set

Parameters

name	name of the parameter
desc	description of the parameter
valueptr	pointer to store the current parameter value, or NULL
isadvanced	is this parameter an advanced parameter?
defaultvalue	default value of the parameter
paramdata	locally defined parameter specific data

void Parameters::paramsetRead ( const char * filename )

reads parameters from a file

Parameters

filename file name

RETCODE Parameters::paramsetSetToDefault ( )

installs default values for all parameters

RETCODE Parameters::paramSetToDefault ( PARAM * param )

sets the parameter to its default setting

Parameters

param parameter

RETCODE Parameters::paramsetWrite	(	const char *	filename,
		bool	comments,
		bool	onlychanged
	)

writes all parameters in the parameter set to a file

Parameters

filename	file name, or NULL for stdout
comments	should parameter descriptions be written as comments?
onlychanged	should only the parameters been written, that are changed from default?

Member Data Documentation

std::map<const char *, PARAM *, strCmp> Parameters::paramset

hash table to store the parameters

Definition at line 150 of file Parameters.h.

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

/home/marco/workspace/svn/Code/LS-Framework/cpp/working/include/easylocal/utils/Parameters.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation