#include <KnapParams.h>
Inheritance diagram for KnapParams:
Public Types | |
| chrDummy | |
| endOfChrParams | |
| intDummy | |
| endOfIntParams | |
| dblDummy | |
| endOfDblParams | |
| strDummy | |
| endOfStrParams | |
| strArrayDummy | |
| endOfStrArrayParams | |
| enum | chrParams { chrDummy, endOfChrParams } |
| Character parameters. More... | |
| enum | intParams { intDummy, endOfIntParams } |
| Integer paramters. More... | |
| enum | dblParams { dblDummy, endOfDblParams } |
| Double parameters. More... | |
| enum | strParams { strDummy, endOfStrParams } |
| String parameters. More... | |
| enum | strArrayParams { strArrayDummy, endOfStrArrayParams } |
| There are no string array parameters. More... | |
Public Member Functions | |
| 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. | |
| void | setEntry (const chrParams key, const char *val) |
| char* is true(1) or false(0), not used | |
| void | setEntry (const chrParams key, const char val) |
| char is true(1) or false(0), not used | |
| void | setEntry (const chrParams 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) |
Constructors. | |
| KnapParams () | |
| The default constructor creates a parameter set with from the template argument structure. | |
Query methods | |
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 chrParams 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 |
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. | |
Definition at line 26 of file KnapParams.h.
Character parameters.
All of these variable are used as booleans (ture = 1, false = 0).
Definition at line 30 of file KnapParams.h.
| KnapParams::KnapParams | ( | ) | [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 71 of file KnapParams.h.
References createKeywordList(), and setDefaultEntries().
| virtual void KnapParams::createKeywordList | ( | ) | [virtual] |
Method for creating the list of keyword looked for in the parameter file.
Implements AlpsParameterSet.
Referenced by KnapParams().
| virtual void KnapParams::setDefaultEntries | ( | ) | [virtual] |
Method for setting the default values for the parameters.
Implements AlpsParameterSet.
Referenced by KnapParams().
| char KnapParams::entry | ( | const chrParams | key | ) | const [inline] |
| int KnapParams::entry | ( | const intParams | key | ) | const [inline] |
| double KnapParams::entry | ( | const dblParams | key | ) | const [inline] |
| const std::string& KnapParams::entry | ( | const strParams | key | ) | const [inline] |
| const std::vector<std::string>& KnapParams::entry | ( | const strArrayParams | key | ) | const [inline] |
| void KnapParams::setEntry | ( | const chrParams | key, | |
| const char * | val | |||
| ) | [inline] |
char* is true(1) or false(0), not used
Definition at line 132 of file KnapParams.h.
References AlpsParameterSet::bpar_.
| void KnapParams::setEntry | ( | const chrParams | key, | |
| const char | val | |||
| ) | [inline] |
char is true(1) or false(0), not used
Definition at line 135 of file KnapParams.h.
References AlpsParameterSet::bpar_.
| void KnapParams::setEntry | ( | const chrParams | key, | |
| const bool | val | |||
| ) | [inline] |
This method is the one that ever been used.
Definition at line 138 of file KnapParams.h.
References AlpsParameterSet::bpar_.
| void KnapParams::setEntry | ( | const intParams | key, | |
| const char * | val | |||
| ) | [inline] |
| void KnapParams::setEntry | ( | const intParams | key, | |
| const int | val | |||
| ) | [inline] |
| void KnapParams::setEntry | ( | const dblParams | key, | |
| const char * | val | |||
| ) | [inline] |
| void KnapParams::setEntry | ( | const dblParams | key, | |
| const double | val | |||
| ) | [inline] |
| void KnapParams::setEntry | ( | const strParams | key, | |
| const char * | val | |||
| ) | [inline] |
| void KnapParams::setEntry | ( | const strArrayParams | key, | |
| const char * | val | |||
| ) | [inline] |
| void KnapParams::pack | ( | AlpsEncoded & | buf | ) | [inline, virtual] |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).
Reimplemented from AlpsParameterSet.
Definition at line 165 of file KnapParams.h.
References AlpsParameterSet::bpar_, AlpsParameterSet::dpar_, endOfChrParams, endOfDblParams, endOfIntParams, endOfStrArrayParams, endOfStrParams, AlpsParameterSet::ipar_, AlpsParameterSet::sapar_, AlpsParameterSet::spar_, and AlpsEncoded::writeRep().
| void KnapParams::unpack | ( | AlpsEncoded & | buf | ) | [inline, virtual] |
Unpack the parameter set from the buffer.
Reimplemented from AlpsParameterSet.
Definition at line 178 of file KnapParams.h.
References AlpsParameterSet::bpar_, AlpsParameterSet::dpar_, endOfChrParams, endOfDblParams, endOfIntParams, endOfStrArrayParams, endOfStrParams, AlpsParameterSet::ipar_, AlpsEncoded::readRep(), AlpsParameterSet::sapar_, and AlpsParameterSet::spar_.
1.4.7