Parameterlist Class Reference

Stores parsed program parameters from input file in Macaulay-style. More...

#include <Parameterlist.h>

Collaboration diagram for Parameterlist:

Collaboration graph

List of all members.

Public Types
typedef std::vector< Parameter * >	ParamListType
Public Member Functions
	Parameterlist ()
virtual	~Parameterlist ()
Operators

bool	paramExists (const string &paramName) const
	checks, if parameter with name paramname exists in Parameter database
void	addParameter (const string &paramName, const string &paramVal, const string &_comment=emptyString)
void	addDefaultParameter (const string &paramName, const string &paramVal, const string &_comment=emptyString)
void	setParameterValue (const string &paramName, const string &paramVal)
	set parameter value to paramwert of given parameter paramname
void	markAsUsed (const string &paramName)
void	resetUsedStatus ()
IO

void	printNotUsedParameters (ostream &os) const
	print not used parameters
void	printUsedParameters (ostream &os) const
Static Public Attributes
static const string	emptyString
Private Attributes
data

ParamListType	parameters_m
get

size_t	getParameterCount () const
Parameter &	getParameterRef (unsigned int idx)
string &	getParameterValueByName (const string &paramName)
	returns parameter value for parameter with name=paramname. If parameter is not in database, returns NULL! TODO: If parameter is not in database, return an empty string.
string &	getParameterValueByName (const char *paramName)
Parameter &	getParameterRefByName (const string &paramName)
Parameter &	getParameterRefByName (const char *paramName)
int	getParameterIdx (const string &paramName) const
	returns the index of parameter with name paramname or -1 if not found

Detailed Description

Author:: Jakob Kröker

Todo:: partially done: rewrite Parameter class and Parameter parser (Kroeker), especially loadParam function, perform at least error checking

Todo:: we have here a parameter List, todo: create a class with parameterOptions? - was hattest du damit gemeint?

Todo:: deleteParameter einfuegen

Definition at line 109 of file Parameterlist.h.

Member Typedef Documentation

typedef std::vector< Parameter * > Parameterlist::ParamListType

Definition at line 118 of file Parameterlist.h.

Constructor & Destructor Documentation

Parameterlist::Parameterlist ( )

Definition at line 105 of file Parameterlist.cc.

References parameters_m.

Parameterlist::~Parameterlist ( ) [virtual]

Definition at line 112 of file Parameterlist.cc.

References parameters_m.

Member Function Documentation

void Parameterlist::addDefaultParameter	(	const string &	paramname,
		const string &	paramValue,
		const string &	pcomment = `emptyString`
	)

Note:: gehe davon aus, dass wenn Standardwerte gesetzt werden, der Parameter benutzt wird.

Definition at line 216 of file Parameterlist.cc.

References eatWS(), Parameter::markUsed(), parameters_m, and paramExists().

Referenced by nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::convertStringParamsToOptions(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initBoolParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initExperimentTag(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initHamiltonianComponentSwitch(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initNonNegativeIntParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initPointFilter(), and nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initRandomSeed().

Here is the call graph for this function:

void Parameterlist::addParameter	(	const string &	paramname,
		const string &	paramValue,
		const string &	pcomment = `emptyString`
	)

Todo:: funktion wellDefined soll schauen, ob nicht ein parameter doppelt vorhanden ist.

Definition at line 197 of file Parameterlist.cc.

References eatWS(), parameters_m, and paramExists().

Referenced by nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initExperimentTag(), and nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::loadParamList().

Here is the call graph for this function:

size_t Parameterlist::getParameterCount ( ) const

Definition at line 123 of file Parameterlist.cc.

References parameters_m.

int Parameterlist::getParameterIdx ( const string & paramName ) const [private]

Definition at line 346 of file Parameterlist.cc.

References parameters_m.

Referenced by getParameterRefByName(), getParameterValueByName(), markAsUsed(), paramExists(), and setParameterValue().

Parameter & Parameterlist::getParameterRef ( unsigned int idx )

Definition at line 129 of file Parameterlist.cc.

References parameters_m.

Parameter & Parameterlist::getParameterRefByName ( const char * paramName )

Definition at line 175 of file Parameterlist.cc.

References getParameterRefByName().

Here is the call graph for this function:

Parameter & Parameterlist::getParameterRefByName ( const string & paramName )

Definition at line 159 of file Parameterlist.cc.

References getParameterIdx(), and parameters_m.

Referenced by nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::convertStringParamsToOptions(), getParameterRefByName(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initBoolParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initExperimentTag(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initFieldCharacteristic(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initHamiltonianComponentSwitch(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initNonNegativeIntParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initPointFilter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initPolynomialDegree(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initRandomSeed(), and nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::loadParamList().

Here is the call graph for this function:

string & Parameterlist::getParameterValueByName ( const char * paramName )

Definition at line 170 of file Parameterlist.cc.

References getParameterValueByName().

Here is the call graph for this function:

string & Parameterlist::getParameterValueByName ( const string & paramName )

Definition at line 145 of file Parameterlist.cc.

References getParameterIdx(), and parameters_m.

Referenced by getParameterValueByName().

Here is the call graph for this function:

void Parameterlist::markAsUsed ( const string & paramName )

Definition at line 240 of file Parameterlist.cc.

References getParameterIdx(), and parameters_m.

Here is the call graph for this function:

bool Parameterlist::paramExists ( const string & paramName ) const

Definition at line 186 of file Parameterlist.cc.

References getParameterIdx().

Referenced by addDefaultParameter(), addParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::convertStringParamsToOptions(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initBoolParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initExperimentTag(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initHamiltonianComponentSwitch(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initNonNegativeIntParameter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initPointFilter(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initPolynomialDegree(), and nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initRandomSeed().

Here is the call graph for this function:

void Parameterlist::printNotUsedParameters ( ostream & os ) const

Definition at line 321 of file Parameterlist.cc.

References parameters_m.

Referenced by nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::printParameters().

void Parameterlist::printUsedParameters ( ostream & os ) const

Definition at line 282 of file Parameterlist.cc.

References Parameter::compareParameterOrder(), and parameters_m.

Referenced by nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::printParameters().

Here is the call graph for this function:

void Parameterlist::resetUsedStatus ( )

Definition at line 270 of file Parameterlist.cc.

References parameters_m.

void Parameterlist::setParameterValue	(	const string &	paramName,
		const string &	paramVal
	)

Todo:: return false, if failed.

Definition at line 256 of file Parameterlist.cc.

References getParameterIdx(), and parameters_m.

Referenced by nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initExperimentTag(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initHamiltonianComponentSwitch(), nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initNonNegativeIntParameter(), and nCenterFocus::CenterfocusParams< TPolynomXY, TRing >::initRandomSeed().

Here is the call graph for this function:

Member Data Documentation

const string Parameterlist::emptyString [static]

Definition at line 116 of file Parameterlist.h.

ParamListType Parameterlist::parameters_m [private]

Definition at line 171 of file Parameterlist.h.

Referenced by addDefaultParameter(), addParameter(), getParameterCount(), getParameterIdx(), getParameterRef(), getParameterRefByName(), getParameterValueByName(), markAsUsed(), Parameterlist(), printNotUsedParameters(), printUsedParameters(), resetUsedStatus(), setParameterValue(), and ~Parameterlist().

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

LinuxSrc/Parameterlist.h
LinuxSrc/Parameterlist.cc

Generated on Tue Nov 23 13:10:53 2010 for centerfocus by 1.6.3