queso-0.56.1
|
#include <BoostInputOptionsParser.h>
Public Member Functions | |
BoostInputOptionsParser (const std::string &filename) | |
Constructor that parses file filename . More... | |
BoostInputOptionsParser () | |
Default constructor that sets m_filename to "". More... | |
virtual | ~BoostInputOptionsParser () |
Destructor. More... | |
void | scanInputFile () |
This is the method that parses the input file. More... | |
template<class T > | |
void | registerOption (std::string name, T defaultValue, std::string description) |
Call this to register an option with the parser. More... | |
void | registerOption (std::string name, std::string description) |
For flags without values. Like a help message, for example. More... | |
template<class T > | |
void | getOption (std::string &name, T &value) |
Get option name from the parser and set value to the parsed value. More... | |
template<> | |
void | getOption (std::string &name, std::set< unsigned int, std::less< unsigned int >, std::allocator< unsigned int > > &value) |
Public Member Functions inherited from QUESO::BaseInputOptionsParser | |
BaseInputOptionsParser () | |
Default constructor. More... | |
virtual | ~BaseInputOptionsParser () |
Destructor. More... | |
Protected Attributes | |
const std::string | m_filename |
ScopedPtr < boost::program_options::options_description > ::Type | m_optionsDescription |
ScopedPtr < boost::program_options::variables_map > ::Type | m_optionsMap |
Private Attributes | |
bool | m_scannedInputFile |
Friends | |
std::ostream & | operator<< (std::ostream &os, const BoostInputOptionsParser &parser) |
Helpful stream operator for printing the parser state. More... | |
Definition at line 44 of file BoostInputOptionsParser.h.
QUESO::BoostInputOptionsParser::BoostInputOptionsParser | ( | const std::string & | filename | ) |
Constructor that parses file filename
.
Definition at line 34 of file BoostInputOptionsParser.C.
References queso_deprecated.
QUESO::BoostInputOptionsParser::BoostInputOptionsParser | ( | ) |
Default constructor that sets m_filename to "".
The use-case that options are not read in from a file but are instead wholly provided by the user.
Definition at line 44 of file BoostInputOptionsParser.C.
References queso_deprecated.
|
virtual |
Destructor.
Deletes m_optionsDescription
Definition at line 54 of file BoostInputOptionsParser.C.
References queso_deprecated.
void QUESO::BoostInputOptionsParser::getOption | ( | std::string & | name, |
T & | value | ||
) |
Get option name
from the parser and set value
to the parsed value.
Definition at line 106 of file BoostInputOptionsParser.C.
References m_scannedInputFile, and queso_deprecated.
Referenced by QUESO::EmOptionsValues::EmOptionsValues(), QUESO::EnvOptionsValues::EnvOptionsValues(), QUESO::GcmOptionsValues::GcmOptionsValues(), QUESO::MLSamplingLevelOptions::getAllOptions(), QUESO::GPMSAOptions::GPMSAOptions(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::McOptionsValues::McOptionsValues(), QUESO::MhOptionsValues::MhOptionsValues(), QUESO::MLSamplingOptions::MLSamplingOptions(), QUESO::OptimizerOptions::OptimizerOptions(), QUESO::SfpOptionsValues::SfpOptionsValues(), QUESO::SipOptionsValues::SipOptionsValues(), and QUESO::SmOptionsValues::SmOptionsValues().
template void QUESO::BoostInputOptionsParser::getOption< std::set< unsigned int, std::less< unsigned int >, std::allocator< unsigned int > > > | ( | std::string & | name, |
std::set< unsigned int, std::less< unsigned int >, std::allocator< unsigned int > > & | value | ||
) |
Definition at line 116 of file BoostInputOptionsParser.C.
References m_scannedInputFile, QUESO::MiscReadDoublesFromString(), and queso_deprecated.
void QUESO::BoostInputOptionsParser::registerOption | ( | std::string | name, |
T | defaultValue, | ||
std::string | description | ||
) |
Call this to register an option with the parser.
The name of the option to look for in the input file is given by name
is given by. If no option is present in the input file, then use defaultValue
is used for the default value for the option. Describe the option with a helpful message using description
.
Definition at line 85 of file BoostInputOptionsParser.C.
References m_optionsDescription, and queso_deprecated.
Referenced by QUESO::MLSamplingLevelOptions::defineAllOptions(), QUESO::EmOptionsValues::EmOptionsValues(), QUESO::EnvOptionsValues::EnvOptionsValues(), QUESO::GcmOptionsValues::GcmOptionsValues(), QUESO::GPMSAOptions::GPMSAOptions(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::McOptionsValues::McOptionsValues(), QUESO::MhOptionsValues::MhOptionsValues(), QUESO::MLSamplingOptions::MLSamplingOptions(), QUESO::OptimizerOptions::OptimizerOptions(), QUESO::SfpOptionsValues::SfpOptionsValues(), QUESO::SipOptionsValues::SipOptionsValues(), and QUESO::SmOptionsValues::SmOptionsValues().
void QUESO::BoostInputOptionsParser::registerOption | ( | std::string | name, |
std::string | description | ||
) |
For flags without values. Like a help message, for example.
Definition at line 96 of file BoostInputOptionsParser.C.
References m_optionsDescription, and queso_deprecated.
void QUESO::BoostInputOptionsParser::scanInputFile | ( | ) |
This is the method that parses the input file.
It parses the input file and sets the m_optionsMap member.
Definition at line 61 of file BoostInputOptionsParser.C.
References m_filename, m_optionsDescription, m_optionsMap, m_scannedInputFile, queso_deprecated, and queso_require_msg.
Referenced by QUESO::EmOptionsValues::EmOptionsValues(), QUESO::EnvOptionsValues::EnvOptionsValues(), QUESO::GcmOptionsValues::GcmOptionsValues(), QUESO::GPMSAOptions::GPMSAOptions(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::McOptionsValues::McOptionsValues(), QUESO::MhOptionsValues::MhOptionsValues(), QUESO::MLSamplingLevelOptions::MLSamplingLevelOptions(), QUESO::MLSamplingOptions::MLSamplingOptions(), QUESO::OptimizerOptions::OptimizerOptions(), QUESO::MLSamplingLevelOptions::scanOptionsValues(), QUESO::SfpOptionsValues::SfpOptionsValues(), QUESO::SipOptionsValues::SipOptionsValues(), and QUESO::SmOptionsValues::SmOptionsValues().
|
friend |
Helpful stream operator for printing the parser state.
Definition at line 154 of file BoostInputOptionsParser.C.
|
protected |
Definition at line 94 of file BoostInputOptionsParser.h.
Referenced by scanInputFile().
|
protected |
Definition at line 96 of file BoostInputOptionsParser.h.
Referenced by QUESO::operator<<(), registerOption(), and scanInputFile().
|
protected |
Definition at line 97 of file BoostInputOptionsParser.h.
Referenced by scanInputFile().
|
private |
Definition at line 100 of file BoostInputOptionsParser.h.
Referenced by getOption(), and scanInputFile().