Alps 1.5.11
|
#include <AbcParams.h>
Public Member Functions | |
Constructors. | |
AbcParams () | |
The default constructor creates a parameter set with from the template argument structure. | |
virtual void | createKeywordList () |
Method for creating the list of keyword looked for in the parameter file. | |
virtual void | setDefaultEntries () |
Method for setting the default values for the parameters. | |
AbcParams () | |
The default constructor creates a parameter set with from the template argument structure. | |
virtual void | createKeywordList () |
Method for creating the list of keyword looked for in the parameter file. | |
virtual void | setDefaultEntries () |
Method for setting the default values for the parameters. | |
Query methods | |
For user application: Following code are do NOT need to change. The reason can not put following functions 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 | |
void | setEntry (const boolParams key, const char val) |
char is true(1) or false(0), not used | |
void | setEntry (const boolParams key, const bool val) |
This method is the one that ever been used. | |
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 | |
void | setEntry (const boolParams key, const char val) |
char is true(1) or false(0), not used | |
void | setEntry (const boolParams key, const bool val) |
This method is the one that ever been used. | |
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). | |
void | unpack (AlpsEncoded &buf) |
Unpack the parameter set from the buffer. | |
void | pack (AlpsEncoded &buf) |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here). | |
void | unpack (AlpsEncoded &buf) |
Unpack the parameter set from the buffer. | |
![]() | |
void | setEntry (const AlpsParameter key, const char *val) |
First, there is the assignment operator that sets the whole parameter set at once. | |
void | readFromStream (std::istream &parstream) |
Read the parameters from the stream specified in the argument. | |
void | readFromFile (const char *paramfile) |
Read parameters from a file. | |
void | readFromArglist (const int argnum, const char *const *arglist) |
Read parameters from the command line. | |
void | writeToStream (std::ostream &outstream) const |
Write keyword-value pairs to the stream specified in the argument. | |
AlpsParameterSet (int c, int i, int d, int s, int sa) | |
The constructor allocate memory for parameters. | |
virtual | ~AlpsParameterSet () |
The destructor deletes all data members. | |
Additional Inherited Members | |
![]() | |
std::vector< std::pair< std::string, AlpsParameter > > | keys_ |
The keyword, parameter pairs. | |
std::string | prefix_ |
Prefix to be used for looking up parameters. | |
std::vector< std::string > | obsoleteKeys_ |
list of obsolete keywords. | |
bool * | bpar_ |
The bool parameters. | |
int * | ipar_ |
The integer parameters. | |
double * | dpar_ |
The double parameters. | |
std::string * | spar_ |
The string (actually, std::string) parameters. | |
int | numSa_ |
The "vector of string" parameters. | |
std::vector< std::string > * | sapar_ |
Definition at line 33 of file AbcParams.h.
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 |
Definition at line 37 of file AbcParams.h.
enum AbcParams::intParams |
Integer paramters.
Definition at line 45 of file AbcParams.h.
enum AbcParams::dblParams |
Double parameters.
Enumerator | |
---|---|
dblDummy | |
endOfDblParams | |
dblDummy | |
endOfDblParams |
Definition at line 55 of file AbcParams.h.
enum AbcParams::strParams |
String parameters.
Enumerator | |
---|---|
strDummy | |
endOfStrParams | |
strDummy | |
endOfStrParams |
Definition at line 62 of file AbcParams.h.
There are no string array parameters.
Enumerator | |
---|---|
strArrayDummy | |
endOfStrArrayParams | |
strArrayDummy | |
endOfStrArrayParams |
Definition at line 69 of file AbcParams.h.
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 |
Definition at line 37 of file AbcParams.h.
enum AbcParams::intParams |
Integer paramters.
Definition at line 45 of file AbcParams.h.
enum AbcParams::dblParams |
Double parameters.
Enumerator | |
---|---|
dblDummy | |
endOfDblParams | |
dblDummy | |
endOfDblParams |
Definition at line 55 of file AbcParams.h.
enum AbcParams::strParams |
String parameters.
Enumerator | |
---|---|
strDummy | |
endOfStrParams | |
strDummy | |
endOfStrParams |
Definition at line 62 of file AbcParams.h.
There are no string array parameters.
Enumerator | |
---|---|
strArrayDummy | |
endOfStrArrayParams | |
strArrayDummy | |
endOfStrArrayParams |
Definition at line 69 of file AbcParams.h.
|
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 81 of file AbcParams.h.
|
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 81 of file AbcParams.h.
|
virtual |
Method for creating the list of keyword looked for in the parameter file.
Implements AlpsParameterSet.
|
virtual |
Method for setting the default values for the parameters.
Implements AlpsParameterSet.
|
inline |
Definition at line 125 of file AbcParams.h.
|
inline |
Definition at line 128 of file AbcParams.h.
|
inline |
Definition at line 131 of file AbcParams.h.
|
inline |
Definition at line 134 of file AbcParams.h.
|
inline |
Definition at line 137 of file AbcParams.h.
|
inline |
char* is true(1) or false(0), not used
Definition at line 142 of file AbcParams.h.
|
inline |
char is true(1) or false(0), not used
Definition at line 145 of file AbcParams.h.
|
inline |
This method is the one that ever been used.
Definition at line 148 of file AbcParams.h.
|
inline |
Definition at line 151 of file AbcParams.h.
|
inline |
Definition at line 154 of file AbcParams.h.
|
inline |
Definition at line 157 of file AbcParams.h.
|
inline |
Definition at line 160 of file AbcParams.h.
|
inline |
Definition at line 163 of file AbcParams.h.
|
inline |
Definition at line 166 of file AbcParams.h.
|
inlinevirtual |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).
Reimplemented from AlpsParameterSet.
Definition at line 175 of file AbcParams.h.
|
inlinevirtual |
Unpack the parameter set from the buffer.
Reimplemented from AlpsParameterSet.
Definition at line 188 of file AbcParams.h.
|
virtual |
Method for creating the list of keyword looked for in the parameter file.
Implements AlpsParameterSet.
|
virtual |
Method for setting the default values for the parameters.
Implements AlpsParameterSet.
|
inline |
Definition at line 125 of file AbcParams.h.
|
inline |
Definition at line 128 of file AbcParams.h.
|
inline |
Definition at line 131 of file AbcParams.h.
|
inline |
Definition at line 134 of file AbcParams.h.
|
inline |
Definition at line 137 of file AbcParams.h.
|
inline |
char* is true(1) or false(0), not used
Definition at line 142 of file AbcParams.h.
|
inline |
char is true(1) or false(0), not used
Definition at line 145 of file AbcParams.h.
|
inline |
This method is the one that ever been used.
Definition at line 148 of file AbcParams.h.
|
inline |
Definition at line 151 of file AbcParams.h.
|
inline |
Definition at line 154 of file AbcParams.h.
|
inline |
Definition at line 157 of file AbcParams.h.
|
inline |
Definition at line 160 of file AbcParams.h.
|
inline |
Definition at line 163 of file AbcParams.h.
|
inline |
Definition at line 166 of file AbcParams.h.
|
inlinevirtual |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).
Reimplemented from AlpsParameterSet.
Definition at line 175 of file AbcParams.h.
|
inlinevirtual |
Unpack the parameter set from the buffer.
Reimplemented from AlpsParameterSet.
Definition at line 188 of file AbcParams.h.