#include <VrpParams.h>
Inheritance diagram for VrpParams:
Public Types | |
doGreedy | |
doExtraInRoot | |
tspProb | |
endOfBoolParams | |
numRoutes | |
verbosity | |
greedyNumTrials | |
whichConnectedRoutine | |
maxNumCutsInShrink | |
whichTspCuts | |
endOfIntParams | |
endOfDblParams | |
strDummy | |
endOfStrParams | |
strArrayDummy | |
endOfStrArrayParams | |
enum | boolParams { doGreedy, doExtraInRoot, tspProb, endOfBoolParams } |
Character parameters. More... | |
enum | intParams { numRoutes, verbosity, greedyNumTrials, whichConnectedRoutine, maxNumCutsInShrink, whichTspCuts, endOfIntParams } |
Integer paramters. More... | |
enum | dblParams { 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 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) |
Constructors. | |
VrpParams () | |
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. | |
bool | 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 |
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 24 of file VrpParams.h.
Character parameters.
All of these variable are used as booleans (true = 1, false = 0).
Definition at line 28 of file VrpParams.h.
enum VrpParams::intParams |
Integer paramters.
numRoutes | |
verbosity | |
greedyNumTrials | |
whichConnectedRoutine | |
maxNumCutsInShrink | |
whichTspCuts | |
endOfIntParams |
Definition at line 36 of file VrpParams.h.
enum VrpParams::dblParams |
enum VrpParams::strParams |
VrpParams::VrpParams | ( | ) | [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 72 of file VrpParams.h.
References createKeywordList(), and setDefaultEntries().
virtual void VrpParams::createKeywordList | ( | ) | [virtual] |
Method for creating the list of keyword looked for in the parameter file.
Implements AlpsParameterSet.
Referenced by VrpParams().
virtual void VrpParams::setDefaultEntries | ( | ) | [virtual] |
Method for setting the default values for the parameters.
Implements AlpsParameterSet.
Referenced by VrpParams().
bool VrpParams::entry | ( | const boolParams | key | ) | const [inline] |
int VrpParams::entry | ( | const intParams | key | ) | const [inline] |
double VrpParams::entry | ( | const dblParams | key | ) | const [inline] |
const std::string& VrpParams::entry | ( | const strParams | key | ) | const [inline] |
const std::vector<std::string>& VrpParams::entry | ( | const strArrayParams | key | ) | const [inline] |
void VrpParams::setEntry | ( | const boolParams | key, | |
const char * | val | |||
) | [inline] |
char* is true(1) or false(0), not used
Definition at line 130 of file VrpParams.h.
References AlpsParameterSet::bpar_.
void VrpParams::setEntry | ( | const boolParams | key, | |
const char | val | |||
) | [inline] |
char is true(1) or false(0), not used
Definition at line 133 of file VrpParams.h.
References AlpsParameterSet::bpar_.
void VrpParams::setEntry | ( | const boolParams | key, | |
const bool | val | |||
) | [inline] |
This method is the one that ever been used.
Definition at line 136 of file VrpParams.h.
References AlpsParameterSet::bpar_.
void VrpParams::setEntry | ( | const intParams | key, | |
const char * | val | |||
) | [inline] |
void VrpParams::setEntry | ( | const intParams | key, | |
const int | val | |||
) | [inline] |
void VrpParams::setEntry | ( | const dblParams | key, | |
const char * | val | |||
) | [inline] |
void VrpParams::setEntry | ( | const dblParams | key, | |
const double | val | |||
) | [inline] |
void VrpParams::setEntry | ( | const strParams | key, | |
const char * | val | |||
) | [inline] |
void VrpParams::setEntry | ( | const strArrayParams | key, | |
const char * | val | |||
) | [inline] |
void VrpParams::pack | ( | AlpsEncoded & | buf | ) | [inline, virtual] |
Pack the parameter set into the buffer (AlpsEncoded is used as buffer Here).
Reimplemented from AlpsParameterSet.
Definition at line 163 of file VrpParams.h.
References AlpsParameterSet::bpar_, AlpsParameterSet::dpar_, endOfBoolParams, endOfDblParams, endOfIntParams, endOfStrArrayParams, endOfStrParams, AlpsParameterSet::ipar_, AlpsParameterSet::sapar_, AlpsParameterSet::spar_, and AlpsEncoded::writeRep().
void VrpParams::unpack | ( | AlpsEncoded & | buf | ) | [inline, virtual] |
Unpack the parameter set from the buffer.
Reimplemented from AlpsParameterSet.
Definition at line 176 of file VrpParams.h.
References AlpsParameterSet::bpar_, AlpsParameterSet::dpar_, endOfBoolParams, endOfDblParams, endOfIntParams, endOfStrArrayParams, endOfStrParams, AlpsParameterSet::ipar_, AlpsEncoded::readRep(), AlpsParameterSet::sapar_, and AlpsParameterSet::spar_.