AbcParams Class Reference

#include <AbcParams.h>

Inheritance diagram for AbcParams:

Collaboration diagram for AbcParams:

Public Types
enum	boolParams {   cutDuringRampup, endOfBoolParams, cutDuringRampup, endOfBoolParams,   cutDuringRampup, endOfBoolParams }
	Character parameters. More...
enum	intParams {   statusInterval, logLevel, endOfIntParams, statusInterval,   logLevel, endOfIntParams, statusInterval, logLevel,   endOfIntParams }
	Integer paramters. More...
enum	dblParams {   dblDummy, endOfDblParams, dblDummy, endOfDblParams,   dblDummy, endOfDblParams }
	Double parameters. More...
enum	strParams {   strDummy, endOfStrParams, strDummy, endOfStrParams,   strDummy, endOfStrParams }
	String parameters. More...
enum	strArrayParams {   strArrayDummy, endOfStrArrayParams, strArrayDummy, endOfStrArrayParams,   strArrayDummy, endOfStrArrayParams }
	There are no string array parameters. More...
enum	boolParams {   cutDuringRampup, endOfBoolParams, cutDuringRampup, endOfBoolParams,   cutDuringRampup, endOfBoolParams }
	Character parameters. More...
enum	intParams {   statusInterval, logLevel, endOfIntParams, statusInterval,   logLevel, endOfIntParams, statusInterval, logLevel,   endOfIntParams }
	Integer paramters. More...
enum	dblParams {   dblDummy, endOfDblParams, dblDummy, endOfDblParams,   dblDummy, endOfDblParams }
	Double parameters. More...
enum	strParams {   strDummy, endOfStrParams, strDummy, endOfStrParams,   strDummy, endOfStrParams }
	String parameters. More...
enum	strArrayParams {   strArrayDummy, endOfStrArrayParams, strArrayDummy, endOfStrArrayParams,   strArrayDummy, endOfStrArrayParams }
	There are no string array parameters. More...
enum	boolParams {   cutDuringRampup, endOfBoolParams, cutDuringRampup, endOfBoolParams,   cutDuringRampup, endOfBoolParams }
	Character parameters. More...
enum	intParams {   statusInterval, logLevel, endOfIntParams, statusInterval,   logLevel, endOfIntParams, statusInterval, logLevel,   endOfIntParams }
	Integer paramters. More...
enum	dblParams {   dblDummy, endOfDblParams, dblDummy, endOfDblParams,   dblDummy, endOfDblParams }
	Double parameters. More...
enum	strParams {   strDummy, endOfStrParams, strDummy, endOfStrParams,   strDummy, endOfStrParams }
	String parameters. More...
enum	strArrayParams {   strArrayDummy, endOfStrArrayParams, strArrayDummy, endOfStrArrayParams,   strArrayDummy, endOfStrArrayParams }
	There are no string array parameters. More...

Public Member Functions
Constructors.
	AbcParams ()
	The default constructor creates a parameter set with from the template argument structure. More...
virtual void	createKeywordList ()
	Method for creating the list of keyword looked for in the parameter file. More...
virtual void	setDefaultEntries ()
	Method for setting the default values for the parameters. More...
	AbcParams ()
	The default constructor creates a parameter set with from the template argument structure. More...
virtual void	createKeywordList ()
	Method for creating the list of keyword looked for in the parameter file. More...
virtual void	setDefaultEntries ()
	Method for setting the default values for the parameters. More...
	AbcParams ()
	The default constructor creates a parameter set with from the template argument structure. More...
virtual void	createKeywordList ()
	Method for creating the list of keyword looked for in the parameter file. More...
virtual void	setDefaultEntries ()
	Method for setting the default values for the parameters. More...
Query methods
For user application: Following code are do NOT need to change. The reason can not put following functions in base class AlpsParameterSet is that boolParams and endOfBoolParams etc., are NOT the same as those declared in base class. The members of the parameter set can be queried for using the overloaded entry() method. Using the example in the class documentation the user can get a parameter with the "<code>param.entry(USER_par::parameter_name)</code>" expression.
char	entry (const boolParams key) const
int	entry (const intParams key) const
double	entry (const dblParams key) const
const std::string &	entry (const strParams key) const
const std::vector< std::string > &	entry (const strArrayParams key) const
void	setEntry (const boolParams key, const char *val)
	char* is true(1) or false(0), not used More...
void	setEntry (const boolParams key, const char val)
	char is true(1) or false(0), not used More...
void	setEntry (const boolParams key, const bool val)
	This method is the one that ever been used. More...
void	setEntry (const intParams key, const char *val)
void	setEntry (const intParams key, const int val)
void	setEntry (const dblParams key, const char *val)
void	setEntry (const dblParams key, const double val)
void	setEntry (const strParams key, const char *val)
void	setEntry (const strArrayParams key, const char *val)
char	entry (const boolParams key) const
int	entry (const intParams key) const
double	entry (const dblParams key) const
const std::string &	entry (const strParams key) const
const std::vector< std::string > &	entry (const strArrayParams key) const
void	setEntry (const boolParams key, const char *val)
	char* is true(1) or false(0), not used More...
void	setEntry (const boolParams key, const char val)
	char is true(1) or false(0), not used More...
void	setEntry (const boolParams key, const bool val)
	This method is the one that ever been used. More...
void	setEntry (const intParams key, const char *val)
void	setEntry (const intParams key, const int val)
void	setEntry (const dblParams key, const char *val)
void	setEntry (const dblParams key, const double val)
void	setEntry (const strParams key, const char *val)
void	setEntry (const strArrayParams key, const char *val)
char	entry (const boolParams key) const
int	entry (const intParams key) const
double	entry (const dblParams key) const
const std::string &	entry (const strParams key) const
const std::vector< std::string > &	entry (const strArrayParams key) const
void	setEntry (const boolParams key, const char *val)
	char* is true(1) or false(0), not used More...
void	setEntry (const boolParams key, const char val)
	char is true(1) or false(0), not used More...
void	setEntry (const boolParams key, const bool val)
	This method is the one that ever been used. More...
void	setEntry (const intParams key, const char *val)
void	setEntry (const intParams key, const int val)
void	setEntry (const dblParams key, const char *val)
void	setEntry (const dblParams key, const double val)
void	setEntry (const strParams key, const char *val)
void	setEntry (const strArrayParams key, const char *val)
Packing/unpacking methods
void	pack (AlpsEncoded &buf)
	Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here). More...
void	unpack (AlpsEncoded &buf)
	Unpack the parameter set from the buffer. More...
void	pack (AlpsEncoded &buf)
	Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here). More...
void	unpack (AlpsEncoded &buf)
	Unpack the parameter set from the buffer. More...
void	pack (AlpsEncoded &buf)
	Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here). More...
void	unpack (AlpsEncoded &buf)
	Unpack the parameter set from the buffer. More...
Public Member Functions inherited from AlpsParameterSet
void	setEntry (const AlpsParameter key, const char *val)
	First, there is the assignment operator that sets the whole parameter set at once. More...
void	readFromStream (std::istream &parstream)
	Read the parameters from the stream specified in the argument. More...
void	readFromFile (const char *paramfile)
	Read parameters from a file. More...
void	readFromArglist (const int argnum, const char *const *arglist)
	Read parameters from the command line. More...
void	writeToStream (std::ostream &outstream) const
	Write keyword-value pairs to the stream specified in the argument. More...
	AlpsParameterSet (int c, int i, int d, int s, int sa)
	The constructor allocate memory for parameters. More...
virtual	~AlpsParameterSet ()
	The destructor deletes all data members. More...

Additional Inherited Members
Protected Attributes inherited from AlpsParameterSet
std::vector< std::pair< std::string, AlpsParameter > >	keys_
	The keyword, parameter pairs. More...
std::string	prefix_
	Prefix to be used for looking up parameters. More...
std::vector< std::string >	obsoleteKeys_
	list of obsolete keywords. More...
bool *	bpar_
	The bool parameters. More...
int *	ipar_
	The integer parameters. More...
double *	dpar_
	The double parameters. More...
std::string *	spar_
	The string (actually, std::string) parameters. More...
int	numSa_
	The "vector of string" parameters. More...
std::vector< std::string > *	sapar_

Detailed Description

Definition at line 37 of file AbcParams.h.

Member Enumeration Documentation

boolParams [1/3]

enum AbcParams::boolParams

Character parameters.

All of these variable are used as booleans (ture = 1, false = 0).

Enumerator
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams

Definition at line 41 of file AbcParams.h.

intParams [1/3]

enum AbcParams::intParams

Integer paramters.

Enumerator
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams

Definition at line 49 of file AbcParams.h.

dblParams [1/3]

enum AbcParams::dblParams

Double parameters.

Enumerator
dblDummy
endOfDblParams
dblDummy
endOfDblParams
dblDummy
endOfDblParams

Definition at line 59 of file AbcParams.h.

strParams [1/3]

enum AbcParams::strParams

String parameters.

Enumerator
strDummy
endOfStrParams
strDummy
endOfStrParams
strDummy
endOfStrParams

Definition at line 66 of file AbcParams.h.

strArrayParams [1/3]

enum AbcParams::strArrayParams

There are no string array parameters.

Enumerator
strArrayDummy
endOfStrArrayParams
strArrayDummy
endOfStrArrayParams
strArrayDummy
endOfStrArrayParams

Definition at line 73 of file AbcParams.h.

boolParams [2/3]

enum AbcParams::boolParams

Character parameters.

All of these variable are used as booleans (ture = 1, false = 0).

Enumerator
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams

Definition at line 41 of file AbcParams.h.

intParams [2/3]

enum AbcParams::intParams

Integer paramters.

Enumerator
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams

Definition at line 49 of file AbcParams.h.

dblParams [2/3]

enum AbcParams::dblParams

Double parameters.

Enumerator
dblDummy
endOfDblParams
dblDummy
endOfDblParams
dblDummy
endOfDblParams

Definition at line 59 of file AbcParams.h.

strParams [2/3]

enum AbcParams::strParams

String parameters.

Enumerator
strDummy
endOfStrParams
strDummy
endOfStrParams
strDummy
endOfStrParams

Definition at line 66 of file AbcParams.h.

strArrayParams [2/3]

enum AbcParams::strArrayParams

There are no string array parameters.

Enumerator
strArrayDummy
endOfStrArrayParams
strArrayDummy
endOfStrArrayParams
strArrayDummy
endOfStrArrayParams

Definition at line 73 of file AbcParams.h.

boolParams [3/3]

enum AbcParams::boolParams

Character parameters.

All of these variable are used as booleans (ture = 1, false = 0).

Enumerator
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams
cutDuringRampup	Whether generate cuts during rampup.
endOfBoolParams

Definition at line 41 of file AbcParams.h.

intParams [3/3]

enum AbcParams::intParams

Integer paramters.

Enumerator
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams
statusInterval	The interval (number of nodes) to report current search status.
logLevel
endOfIntParams

Definition at line 49 of file AbcParams.h.

dblParams [3/3]

enum AbcParams::dblParams

Double parameters.

Enumerator
dblDummy
endOfDblParams
dblDummy
endOfDblParams
dblDummy
endOfDblParams

Definition at line 59 of file AbcParams.h.

strParams [3/3]

enum AbcParams::strParams

String parameters.

Enumerator
strDummy
endOfStrParams
strDummy
endOfStrParams
strDummy
endOfStrParams

Definition at line 66 of file AbcParams.h.

strArrayParams [3/3]

enum AbcParams::strArrayParams

There are no string array parameters.

Enumerator
strArrayDummy
endOfStrArrayParams
strArrayDummy
endOfStrArrayParams
strArrayDummy
endOfStrArrayParams

Definition at line 73 of file AbcParams.h.

Constructor & Destructor Documentation

AbcParams() [1/3]

AbcParams::AbcParams ( )

inline

The default constructor creates a parameter set with from the template argument structure.

The keyword list is created and the defaults are set.

Definition at line 85 of file AbcParams.h.

AbcParams() [2/3]

AbcParams::AbcParams ( )

inline

The default constructor creates a parameter set with from the template argument structure.

The keyword list is created and the defaults are set.

Definition at line 85 of file AbcParams.h.

AbcParams() [3/3]

AbcParams::AbcParams ( )

inline

The default constructor creates a parameter set with from the template argument structure.

The keyword list is created and the defaults are set.

Definition at line 85 of file AbcParams.h.

Member Function Documentation

createKeywordList() [1/3]

virtual void AbcParams::createKeywordList ( )

virtual

Method for creating the list of keyword looked for in the parameter file.

Implements AlpsParameterSet.

setDefaultEntries() [1/3]

virtual void AbcParams::setDefaultEntries ( )

virtual

Method for setting the default values for the parameters.

Implements AlpsParameterSet.

entry() [1/15]

char AbcParams::entry ( const boolParams  key ) const

inline

Definition at line 129 of file AbcParams.h.

entry() [2/15]

int AbcParams::entry ( const intParams  key ) const

inline

Definition at line 132 of file AbcParams.h.

entry() [3/15]

double AbcParams::entry ( const dblParams  key ) const

inline

Definition at line 135 of file AbcParams.h.

entry() [4/15]

const std::string& AbcParams::entry ( const strParams  key ) const

inline

Definition at line 138 of file AbcParams.h.

entry() [5/15]

const std::vector<std::string>& AbcParams::entry ( const strArrayParams  key ) const

inline

Definition at line 141 of file AbcParams.h.

setEntry() [1/27]

void AbcParams::setEntry ( const boolParams  key, const char *  val  )

inline

char* is true(1) or false(0), not used

Definition at line 146 of file AbcParams.h.

setEntry() [2/27]

void AbcParams::setEntry ( const boolParams  key, const char  val  )

inline

char is true(1) or false(0), not used

Definition at line 149 of file AbcParams.h.

setEntry() [3/27]

void AbcParams::setEntry ( const boolParams  key, const bool  val  )

inline

This method is the one that ever been used.

Definition at line 152 of file AbcParams.h.

setEntry() [4/27]

void AbcParams::setEntry ( const intParams  key, const char *  val  )

inline

Definition at line 155 of file AbcParams.h.

setEntry() [5/27]

void AbcParams::setEntry ( const intParams  key, const int  val  )

inline

Definition at line 158 of file AbcParams.h.

setEntry() [6/27]

void AbcParams::setEntry ( const dblParams  key, const char *  val  )

inline

Definition at line 161 of file AbcParams.h.

setEntry() [7/27]

void AbcParams::setEntry ( const dblParams  key, const double  val  )

inline

Definition at line 164 of file AbcParams.h.

setEntry() [8/27]

void AbcParams::setEntry ( const strParams  key, const char *  val  )

inline

Definition at line 167 of file AbcParams.h.

setEntry() [9/27]

void AbcParams::setEntry ( const strArrayParams  key, const char *  val  )

inline

Definition at line 170 of file AbcParams.h.

pack() [1/3]

void AbcParams::pack ( AlpsEncoded &  buf )

inlinevirtual

Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).

Reimplemented from AlpsParameterSet.

Definition at line 179 of file AbcParams.h.

unpack() [1/3]

void AbcParams::unpack ( AlpsEncoded &  buf )

inlinevirtual

Unpack the parameter set from the buffer.

Reimplemented from AlpsParameterSet.

Definition at line 192 of file AbcParams.h.

createKeywordList() [2/3]

virtual void AbcParams::createKeywordList ( )

virtual

Method for creating the list of keyword looked for in the parameter file.

Implements AlpsParameterSet.

setDefaultEntries() [2/3]

virtual void AbcParams::setDefaultEntries ( )

virtual

Method for setting the default values for the parameters.

Implements AlpsParameterSet.

entry() [6/15]

char AbcParams::entry ( const boolParams  key ) const

inline

Definition at line 129 of file AbcParams.h.

entry() [7/15]

int AbcParams::entry ( const intParams  key ) const

inline

Definition at line 132 of file AbcParams.h.

entry() [8/15]

double AbcParams::entry ( const dblParams  key ) const

inline

Definition at line 135 of file AbcParams.h.

entry() [9/15]

const std::string& AbcParams::entry ( const strParams  key ) const

inline

Definition at line 138 of file AbcParams.h.

entry() [10/15]

const std::vector<std::string>& AbcParams::entry ( const strArrayParams  key ) const

inline

Definition at line 141 of file AbcParams.h.

setEntry() [10/27]

void AbcParams::setEntry ( const boolParams  key, const char *  val  )

inline

char* is true(1) or false(0), not used

Definition at line 146 of file AbcParams.h.

setEntry() [11/27]

void AbcParams::setEntry ( const boolParams  key, const char  val  )

inline

char is true(1) or false(0), not used

Definition at line 149 of file AbcParams.h.

setEntry() [12/27]

void AbcParams::setEntry ( const boolParams  key, const bool  val  )

inline

This method is the one that ever been used.

Definition at line 152 of file AbcParams.h.

setEntry() [13/27]

void AbcParams::setEntry ( const intParams  key, const char *  val  )

inline

Definition at line 155 of file AbcParams.h.

setEntry() [14/27]

void AbcParams::setEntry ( const intParams  key, const int  val  )

inline

Definition at line 158 of file AbcParams.h.

setEntry() [15/27]

void AbcParams::setEntry ( const dblParams  key, const char *  val  )

inline

Definition at line 161 of file AbcParams.h.

setEntry() [16/27]

void AbcParams::setEntry ( const dblParams  key, const double  val  )

inline

Definition at line 164 of file AbcParams.h.

setEntry() [17/27]

void AbcParams::setEntry ( const strParams  key, const char *  val  )

inline

Definition at line 167 of file AbcParams.h.

setEntry() [18/27]

void AbcParams::setEntry ( const strArrayParams  key, const char *  val  )

inline

Definition at line 170 of file AbcParams.h.

pack() [2/3]

void AbcParams::pack ( AlpsEncoded &  buf )

inlinevirtual

Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).

Reimplemented from AlpsParameterSet.

Definition at line 179 of file AbcParams.h.

unpack() [2/3]

void AbcParams::unpack ( AlpsEncoded &  buf )

inlinevirtual

Unpack the parameter set from the buffer.

Reimplemented from AlpsParameterSet.

Definition at line 192 of file AbcParams.h.

createKeywordList() [3/3]

virtual void AbcParams::createKeywordList ( )

virtual

Method for creating the list of keyword looked for in the parameter file.

Implements AlpsParameterSet.

setDefaultEntries() [3/3]

virtual void AbcParams::setDefaultEntries ( )

virtual

Method for setting the default values for the parameters.

Implements AlpsParameterSet.

entry() [11/15]

char AbcParams::entry ( const boolParams  key ) const

inline

Definition at line 129 of file AbcParams.h.

entry() [12/15]

int AbcParams::entry ( const intParams  key ) const

inline

Definition at line 132 of file AbcParams.h.

entry() [13/15]

double AbcParams::entry ( const dblParams  key ) const

inline

Definition at line 135 of file AbcParams.h.

entry() [14/15]

const std::string& AbcParams::entry ( const strParams  key ) const

inline

Definition at line 138 of file AbcParams.h.

entry() [15/15]

const std::vector<std::string>& AbcParams::entry ( const strArrayParams  key ) const

inline

Definition at line 141 of file AbcParams.h.

setEntry() [19/27]

void AbcParams::setEntry ( const boolParams  key, const char *  val  )

inline

char* is true(1) or false(0), not used

Definition at line 146 of file AbcParams.h.

setEntry() [20/27]

void AbcParams::setEntry ( const boolParams  key, const char  val  )

inline

char is true(1) or false(0), not used

Definition at line 149 of file AbcParams.h.

setEntry() [21/27]

void AbcParams::setEntry ( const boolParams  key, const bool  val  )

inline

This method is the one that ever been used.

Definition at line 152 of file AbcParams.h.

setEntry() [22/27]

void AbcParams::setEntry ( const intParams  key, const char *  val  )

inline

Definition at line 155 of file AbcParams.h.

setEntry() [23/27]

void AbcParams::setEntry ( const intParams  key, const int  val  )

inline

Definition at line 158 of file AbcParams.h.

setEntry() [24/27]

void AbcParams::setEntry ( const dblParams  key, const char *  val  )

inline

Definition at line 161 of file AbcParams.h.

setEntry() [25/27]

void AbcParams::setEntry ( const dblParams  key, const double  val  )

inline

Definition at line 164 of file AbcParams.h.

setEntry() [26/27]

void AbcParams::setEntry ( const strParams  key, const char *  val  )

inline

Definition at line 167 of file AbcParams.h.

setEntry() [27/27]

void AbcParams::setEntry ( const strArrayParams  key, const char *  val  )

inline

Definition at line 170 of file AbcParams.h.

pack() [3/3]

void AbcParams::pack ( AlpsEncoded &  buf )

inlinevirtual

Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).

Reimplemented from AlpsParameterSet.

Definition at line 179 of file AbcParams.h.

unpack() [3/3]

void AbcParams::unpack ( AlpsEncoded &  buf )

inlinevirtual

Unpack the parameter set from the buffer.

Reimplemented from AlpsParameterSet.

Definition at line 192 of file AbcParams.h.

---

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

• /home/ted/Projects/Alps/Alps/examples/Abc/AbcParams.h