QUESO::BoostInputOptionsParser Class Reference

#include <BoostInputOptionsParser.h>

Inheritance diagram for QUESO::BoostInputOptionsParser:

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 (const std::string &name, const T &defaultValue, const std::string &description)
	Call this to register an option with the parser. More...
void	registerOption (const std::string &name, const std::string &description)
	For flags without values. Like a help message, for example. More...
template<class T >
void	getOption (const std::string &name, T &value) const
	Get option name from the parser and set value to the parsed value. More...
template<>
void	getOption (const std::string &name, std::set< unsigned int, std::less< unsigned int >, std::allocator< unsigned int > > &value) const
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...

Detailed Description

Definition at line 45 of file BoostInputOptionsParser.h.

Constructor & Destructor Documentation

QUESO::BoostInputOptionsParser::BoostInputOptionsParser

(

const std::string &

filename

)

Constructor that parses file filename.

Definition at line 35 of file BoostInputOptionsParser.C.

  :
    m_filename(filename),
    m_optionsDescription(new boost::program_options::options_description("Input options")),
    m_optionsMap(new boost::program_options::variables_map()),
    m_scannedInputFile(false)
{
  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 45 of file BoostInputOptionsParser.C.

  :
    m_filename(""),
    m_optionsDescription(new boost::program_options::options_description("Input options")),
    m_optionsMap(new boost::program_options::variables_map()),
    m_scannedInputFile(false)
{
  queso_deprecated();
}

QUESO::BoostInputOptionsParser::~BoostInputOptionsParser ( )

virtual

Destructor.

Deletes m_optionsDescription

Definition at line 55 of file BoostInputOptionsParser.C.

{
  queso_deprecated();
  // Do nothing
}

Member Function Documentation

template<typename T >

void QUESO::BoostInputOptionsParser::getOption	(	const std::string &	name,
		T &	value
	)		const

Get option name from the parser and set value to the parsed value.

Definition at line 109 of file BoostInputOptionsParser.C.

References m_scannedInputFile.

Referenced by QUESO::MLSamplingLevelOptions::getAllOptions(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::MLSamplingOptions::MLSamplingOptions(), and QUESO::OptimizerOptions::OptimizerOptions().

{
  queso_deprecated();
  if (m_scannedInputFile) {
    value = (*m_optionsMap)[name].as<T>();
  }
}

template<>

template void QUESO::BoostInputOptionsParser::getOption< std::set< unsigned int, std::less< unsigned int >, std::allocator< unsigned int > > >	(	const std::string &	name,
		std::set< unsigned int, std::less< unsigned int >, std::allocator< unsigned int > > &	value
	)		const

Definition at line 119 of file BoostInputOptionsParser.C.

References m_scannedInputFile, and QUESO::MiscReadDoublesFromString().

{
  queso_deprecated();
  if (m_scannedInputFile) {
    // Clear before putting things in it
    value.clear();

    // Get the option as a string
    // DM:  Why do it this way?  Doesn't boost support vectors as input
    //      options?
    std::vector<double> tmpVec(0, 0.0);
    std::string optionValue;
    this->getOption<std::string>(name, optionValue);
    MiscReadDoublesFromString(optionValue, tmpVec);

    for (unsigned int i = 0; i < tmpVec.size(); i++) {
      value.insert((unsigned int) tmpVec[i]);  // Why cast?!
    }
  }
}

template<typename T >

void QUESO::BoostInputOptionsParser::registerOption	(	const std::string &	name,
		const T &	defaultValue,
		const 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 86 of file BoostInputOptionsParser.C.

References m_optionsDescription.

Referenced by QUESO::MLSamplingLevelOptions::defineAllOptions(), QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::MLSamplingOptions::MLSamplingOptions(), and QUESO::OptimizerOptions::OptimizerOptions().

{
  queso_deprecated();
  m_optionsDescription->add_options()
    (name.c_str(),
     boost::program_options::value<T>()->default_value(defaultValue),
     description.c_str());
}

void QUESO::BoostInputOptionsParser::registerOption	(	const std::string &	name,
		const std::string &	description
	)

For flags without values. Like a help message, for example.

Definition at line 98 of file BoostInputOptionsParser.C.

References m_optionsDescription.

{
  queso_deprecated();
  m_optionsDescription->add_options()
    (name.c_str(),
     description.c_str());
}

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 62 of file BoostInputOptionsParser.C.

References m_filename, m_optionsDescription, m_optionsMap, and m_scannedInputFile.

Referenced by QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions(), QUESO::MLSamplingLevelOptions::MLSamplingLevelOptions(), QUESO::MLSamplingOptions::MLSamplingOptions(), QUESO::OptimizerOptions::OptimizerOptions(), and QUESO::MLSamplingLevelOptions::scanOptionsValues().

{
  queso_deprecated();
  queso_require_msg(m_optionsDescription, "m_optionsDescription variable is NULL");

  // If it's the empty string then the defaults are used
  if (m_filename != "") {
    std::ifstream ifs;
    ifs.open(m_filename.c_str());

    queso_require_msg(m_optionsMap, "m_allOptionsMap variable is NULL");
    boost::program_options::store(
        boost::program_options::parse_config_file(
          ifs, *m_optionsDescription, true), *m_optionsMap);
    boost::program_options::notify(*m_optionsMap);

    ifs.close();

    m_scannedInputFile = true;
  }
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const BoostInputOptionsParser &  parser  )

friend

Helpful stream operator for printing the parser state.

Definition at line 157 of file BoostInputOptionsParser.C.

{
  queso_deprecated();
  os << *(parser.m_optionsDescription);
  return os;
}

Member Data Documentation

const std::string QUESO::BoostInputOptionsParser::m_filename

protected

Definition at line 97 of file BoostInputOptionsParser.h.

Referenced by scanInputFile().

ScopedPtr<boost::program_options::options_description>::Type QUESO::BoostInputOptionsParser::m_optionsDescription

protected

Definition at line 99 of file BoostInputOptionsParser.h.

Referenced by QUESO::operator<<(), registerOption(), and scanInputFile().

ScopedPtr<boost::program_options::variables_map>::Type QUESO::BoostInputOptionsParser::m_optionsMap

protected

Definition at line 100 of file BoostInputOptionsParser.h.

Referenced by scanInputFile().

bool QUESO::BoostInputOptionsParser::m_scannedInputFile

private

Definition at line 103 of file BoostInputOptionsParser.h.

Referenced by getOption(), and scanInputFile().

---

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

• src/core/inc/BoostInputOptionsParser.h
• src/core/src/BoostInputOptionsParser.C