QUESO::MonteCarloSGOptions Class Reference

This class reads the options for the Monte Carlo sequence generator from an input file. More...

#include <MonteCarloSGOptions.h>

Collaboration diagram for QUESO::MonteCarloSGOptions:

Public Member Functions
Constructor/Destructor methods
	MonteCarloSGOptions (const BaseEnvironment &env, const char *prefix)
	Constructor: reads options from the input file. More...
	MonteCarloSGOptions (const BaseEnvironment &env, const char *prefix, const McOptionsValues &alternativeOptionsValues)
	Constructor: with alternative option values. More...
	~MonteCarloSGOptions ()
	Destructor. More...
I/O methods
void	scanOptionsValues ()
	It scans the option values from the options input file. More...
void	print (std::ostream &os) const
	It prints the option values. More...

Public Attributes
McOptionsValues	m_ov
std::string	m_prefix

Private Member Functions
void	defineMyOptions (boost::program_options::options_description &optionsDesc) const
	Defines the options for the Monte Carlo sequence generator as the default options. More...
void	getMyOptionValues (boost::program_options::options_description &optionsDesc)
	Gets the sequence options. More...

Private Attributes
const BaseEnvironment &	m_env
boost::program_options::options_description *	m_optionsDesc
std::string	m_option_help
std::string	m_option_dataOutputFileName
std::string	m_option_dataOutputAllowedSet
std::string	m_option_pseq_dataOutputPeriod
std::string	m_option_pseq_dataOutputFileName
std::string	m_option_pseq_dataOutputFileType
std::string	m_option_pseq_dataOutputAllowedSet
std::string	m_option_qseq_dataInputFileName
std::string	m_option_qseq_dataInputFileType
std::string	m_option_qseq_size
std::string	m_option_qseq_displayPeriod
std::string	m_option_qseq_measureRunTimes
std::string	m_option_qseq_dataOutputPeriod
std::string	m_option_qseq_dataOutputFileName
std::string	m_option_qseq_dataOutputFileType
std::string	m_option_qseq_dataOutputAllowedSet

Detailed Description

This class reads the options for the Monte Carlo sequence generator from an input file.

Monte Carlo sequence generator expects options for its methods. This class reads the options for the Monte Carlo sequence generator from an input file provided by the user. The class expects the prefix '<prefix>_mc_'. For instance, if 'prefix' is 'foo_775_fp_', then the constructor will read all options that begin with 'foo_775_fp_mc_'.

Definition at line 199 of file MonteCarloSGOptions.h.

Constructor & Destructor Documentation

QUESO::MonteCarloSGOptions::MonteCarloSGOptions	(	const BaseEnvironment &	env,
		const char *	prefix
	)

Constructor: reads options from the input file.

Definition at line 372 of file MonteCarloSGOptions.C.

References m_env, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, and queso_require_not_equal_to_msg.

  :
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_ov                              (NULL,NULL),
  m_pseqStatisticalOptionsObj       (NULL),
  m_qseqStatisticalOptionsObj       (NULL),
#else
  m_ov                              (),
#endif
  m_prefix                          ((std::string)(prefix) + "mc_"),
  m_env                             (env),
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  m_optionsDesc                     (new boost::program_options::options_description("Monte Carlo options")),
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
  m_option_help                     (m_prefix + "help"                       ),
  m_option_dataOutputFileName       (m_prefix + "dataOutputFileName"         ),
  m_option_dataOutputAllowedSet     (m_prefix + "dataOutputAllowedSet"       ),
  m_option_pseq_dataOutputPeriod    (m_prefix + "pseq_dataOutputPeriod"      ),
  m_option_pseq_dataOutputFileName  (m_prefix + "pseq_dataOutputFileName"    ),
  m_option_pseq_dataOutputFileType  (m_prefix + "pseq_dataOutputFileType"    ),
  m_option_pseq_dataOutputAllowedSet(m_prefix + "pseq_dataOutputAllowedSet"  ),
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_option_pseq_computeStats        (m_prefix + "pseq_computeStats"          ),
#endif
  m_option_qseq_dataInputFileName   (m_prefix + "qseq_dataInputFileName"     ),
  m_option_qseq_dataInputFileType   (m_prefix + "qseq_dataInputFileType"     ),
  m_option_qseq_size                (m_prefix + "qseq_size"                  ),
  m_option_qseq_displayPeriod       (m_prefix + "qseq_displayPeriod"         ),
  m_option_qseq_measureRunTimes     (m_prefix + "qseq_measureRunTimes"       ),
  m_option_qseq_dataOutputPeriod    (m_prefix + "qseq_dataOutputPeriod"      ),
  m_option_qseq_dataOutputFileName  (m_prefix + "qseq_dataOutputFileName"    ),
  m_option_qseq_dataOutputFileType  (m_prefix + "qseq_dataOutputFileType"    ),
  m_option_qseq_dataOutputAllowedSet(m_prefix + "qseq_dataOutputAllowedSet"  )
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  ,
  m_option_qseq_computeStats        (m_prefix + "qseq_computeStats"          )
#endif
{
  queso_deprecated();
  queso_require_not_equal_to_msg(m_env.optionsInputFileName(), std::string(""), std::string("this constructor is incompatible with the absence of an options input file"));
}

QUESO::MonteCarloSGOptions::MonteCarloSGOptions	(	const BaseEnvironment &	env,
		const char *	prefix,
		const McOptionsValues &	alternativeOptionsValues
	)

Constructor: with alternative option values.

In this constructor, the input options are given by alternativeOptionsValues, thus, they are not read from an input file.

Definition at line 416 of file MonteCarloSGOptions.C.

References m_env, m_ov, m_prefix, QUESO::BaseEnvironment::optionsInputFileName(), queso_deprecated, queso_require_equal_to_msg, and QUESO::BaseEnvironment::subDisplayFile().

  :
  m_ov                              (alternativeOptionsValues),
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_pseqStatisticalOptionsObj       (NULL),
  m_qseqStatisticalOptionsObj       (NULL),
#endif
  m_prefix                          ((std::string)(prefix) + "mc_"),
  m_env                             (env),
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  m_optionsDesc                     (NULL),
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
  m_option_help                     (m_prefix + "help"                     ),
  m_option_dataOutputFileName       (m_prefix + "dataOutputFileName"       ),
  m_option_dataOutputAllowedSet     (m_prefix + "dataOutputAllowedSet"     ),
  m_option_pseq_dataOutputPeriod    (m_prefix + "pseq_dataOutputPeriod"    ),
  m_option_pseq_dataOutputFileName  (m_prefix + "pseq_dataOutputFileName"  ),
  m_option_pseq_dataOutputFileType  (m_prefix + "pseq_dataOutputFileType"  ),
  m_option_pseq_dataOutputAllowedSet(m_prefix + "pseq_dataOutputAllowedSet"),
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_option_pseq_computeStats        (m_prefix + "pseq_computeStats"        ),
#endif
  m_option_qseq_dataInputFileName   (m_prefix + "qseq_dataInputFileName"   ),
  m_option_qseq_dataInputFileType   (m_prefix + "qseq_dataInputFileType"   ),
  m_option_qseq_size                (m_prefix + "qseq_size"                ),
  m_option_qseq_displayPeriod       (m_prefix + "qseq_displayPeriod"       ),
  m_option_qseq_measureRunTimes     (m_prefix + "qseq_measureRunTimes"     ),
  m_option_qseq_dataOutputPeriod    (m_prefix + "qseq_dataOutputPeriod"    ),
  m_option_qseq_dataOutputFileName  (m_prefix + "qseq_dataOutputFileName"  ),
  m_option_qseq_dataOutputFileType  (m_prefix + "qseq_dataOutputFileType"  ),
  m_option_qseq_dataOutputAllowedSet(m_prefix + "qseq_dataOutputAllowedSet")
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  ,
  m_option_qseq_computeStats        (m_prefix + "qseq_computeStats"        )
#endif
{
  queso_deprecated();
  queso_require_equal_to_msg(m_env.optionsInputFileName(), std::string(""), std::string("this constructor is incompatible with the existence of an options input file"));

  if (m_env.subDisplayFile() != NULL) {
    *m_env.subDisplayFile() << "In MonteCarloSGOptions::constructor(2)"
                            << ": after setting values of options with prefix '" << m_prefix
                            << "', state of object is:"
                            << "\n" << *this
                            << std::endl;
  }

  // dakota
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  if (m_ov.m_pseqComputeStats) m_pseqStatisticalOptionsObj =
    new SequenceStatisticalOptions(m_env,m_prefix + "pseq_",m_ov.m_alternativePSsOptionsValues);
  if (m_ov.m_qseqComputeStats) m_qseqStatisticalOptionsObj =
    new SequenceStatisticalOptions(m_env,m_prefix + "qseq_",m_ov.m_alternativeQSsOptionsValues);
#endif
}

QUESO::MonteCarloSGOptions::~MonteCarloSGOptions

(

)

Destructor.

Definition at line 475 of file MonteCarloSGOptions.C.

References m_optionsDesc, and queso_deprecated.

{
  queso_deprecated();

#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  if (m_pseqStatisticalOptionsObj) delete m_pseqStatisticalOptionsObj; // dakota
  if (m_qseqStatisticalOptionsObj) delete m_qseqStatisticalOptionsObj; // dakota
#endif
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  if (m_optionsDesc              ) delete m_optionsDesc;
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS
}

Member Function Documentation

void QUESO::MonteCarloSGOptions::defineMyOptions ( boost::program_options::options_description &  optionsDesc ) const

private

Defines the options for the Monte Carlo sequence generator as the default options.

Definition at line 521 of file MonteCarloSGOptions.C.

References m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_pseq_dataOutputAllowedSet, m_option_pseq_dataOutputFileName, m_option_pseq_dataOutputFileType, m_option_pseq_dataOutputPeriod, m_option_qseq_dataInputFileName, m_option_qseq_dataInputFileType, m_option_qseq_dataOutputAllowedSet, m_option_qseq_dataOutputFileName, m_option_qseq_dataOutputFileType, m_option_qseq_dataOutputPeriod, m_option_qseq_displayPeriod, m_option_qseq_measureRunTimes, m_option_qseq_size, queso_deprecated, UQ_MOC_SG_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_MOC_SG_DATA_OUTPUT_FILE_NAME_ODV, UQ_MOC_SG_PSEQ_COMPUTE_STATS_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_FILE_NAME_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_FILE_TYPE_ODV, UQ_MOC_SG_PSEQ_DATA_OUTPUT_PERIOD_ODV, UQ_MOC_SG_QSEQ_COMPUTE_STATS_ODV, UQ_MOC_SG_QSEQ_DATA_INPUT_FILE_NAME_ODV, UQ_MOC_SG_QSEQ_DATA_INPUT_FILE_TYPE_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_ALLOWED_SET_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_FILE_NAME_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_FILE_TYPE_ODV, UQ_MOC_SG_QSEQ_DATA_OUTPUT_PERIOD_ODV, UQ_MOC_SG_QSEQ_DISPLAY_PERIOD_ODV, UQ_MOC_SG_QSEQ_MEASURE_RUN_TIMES_ODV, and UQ_MOC_SG_QSEQ_SIZE_ODV.

Referenced by scanOptionsValues().

{
  queso_deprecated();

  optionsDesc.add_options()
    (m_option_help.c_str(),                                                                                                            "produce help message for Monte Carlo distribution calculator")
    (m_option_dataOutputFileName.c_str(),        boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_DATA_OUTPUT_FILE_NAME_ODV       ), "name of generic data output file"                            )
    (m_option_dataOutputAllowedSet.c_str(),      boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_DATA_OUTPUT_ALLOWED_SET_ODV     ), "subEnvs that will write to generic data output file"         )
    (m_option_pseq_dataOutputPeriod.c_str(),     boost::program_options::value<unsigned int>()->default_value(UQ_MOC_SG_PSEQ_DATA_OUTPUT_PERIOD_ODV     ), "period of message display during param sequence generation"  )
    (m_option_pseq_dataOutputFileName.c_str(),   boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_PSEQ_DATA_OUTPUT_FILE_NAME_ODV  ), "name of data output file for parameters"                     )
    (m_option_pseq_dataOutputFileType.c_str(),   boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_PSEQ_DATA_OUTPUT_FILE_TYPE_ODV  ), "type of data output file for parameters"                     )
    (m_option_pseq_dataOutputAllowedSet.c_str(), boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_PSEQ_DATA_OUTPUT_ALLOWED_SET_ODV), "subEnvs that will write to data output file for parameters"  )
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
    (m_option_pseq_computeStats.c_str(),         boost::program_options::value<bool        >()->default_value(UQ_MOC_SG_PSEQ_COMPUTE_STATS_ODV          ), "compute statistics on sequence of parameter"                 )
#endif
    (m_option_qseq_dataInputFileName.c_str(),    boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_QSEQ_DATA_INPUT_FILE_NAME_ODV   ), "name of data input file for qois"                            )
    (m_option_qseq_dataInputFileType.c_str(),    boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_QSEQ_DATA_INPUT_FILE_TYPE_ODV   ), "type of data input file for qois"                            )
    (m_option_qseq_size.c_str(),                 boost::program_options::value<unsigned int>()->default_value(UQ_MOC_SG_QSEQ_SIZE_ODV                   ), "size of qoi sequence"                                        )
    (m_option_qseq_displayPeriod.c_str(),        boost::program_options::value<unsigned int>()->default_value(UQ_MOC_SG_QSEQ_DISPLAY_PERIOD_ODV         ), "period of message display during qoi sequence generation"    )
    (m_option_qseq_measureRunTimes.c_str(),      boost::program_options::value<bool        >()->default_value(UQ_MOC_SG_QSEQ_MEASURE_RUN_TIMES_ODV      ), "measure run times"                                           )
    (m_option_qseq_dataOutputPeriod.c_str(),     boost::program_options::value<unsigned int>()->default_value(UQ_MOC_SG_QSEQ_DATA_OUTPUT_PERIOD_ODV     ), "period of message display during qoi sequence generation"    )
    (m_option_qseq_dataOutputFileName.c_str(),   boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_QSEQ_DATA_OUTPUT_FILE_NAME_ODV  ), "name of data output file for qois"                           )
    (m_option_qseq_dataOutputFileType.c_str(),   boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_QSEQ_DATA_OUTPUT_FILE_TYPE_ODV  ), "type of data output file for qois"                           )
    (m_option_qseq_dataOutputAllowedSet.c_str(), boost::program_options::value<std::string >()->default_value(UQ_MOC_SG_QSEQ_DATA_OUTPUT_ALLOWED_SET_ODV), "subEnvs that will write to data output file for qois"        )
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
    (m_option_qseq_computeStats.c_str(),         boost::program_options::value<bool        >()->default_value(UQ_MOC_SG_QSEQ_COMPUTE_STATS_ODV          ), "compute statistics on sequence of qoi"                       )
#endif
   ;

  return;
}

void QUESO::MonteCarloSGOptions::getMyOptionValues ( boost::program_options::options_description &  optionsDesc )

private

Gets the sequence options.

Definition at line 554 of file MonteCarloSGOptions.C.

References QUESO::BaseEnvironment::allOptionsMap(), QUESO::McOptionsValues::m_dataOutputAllowedSet, QUESO::McOptionsValues::m_dataOutputFileName, m_env, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_pseq_dataOutputAllowedSet, m_option_pseq_dataOutputFileName, m_option_pseq_dataOutputFileType, m_option_pseq_dataOutputPeriod, m_option_qseq_dataInputFileName, m_option_qseq_dataInputFileType, m_option_qseq_dataOutputAllowedSet, m_option_qseq_dataOutputFileName, m_option_qseq_dataOutputFileType, m_option_qseq_dataOutputPeriod, m_option_qseq_displayPeriod, m_option_qseq_measureRunTimes, m_option_qseq_size, m_ov, QUESO::McOptionsValues::m_pseqDataOutputAllowedSet, QUESO::McOptionsValues::m_pseqDataOutputFileName, QUESO::McOptionsValues::m_pseqDataOutputFileType, QUESO::McOptionsValues::m_pseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDataInputFileName, QUESO::McOptionsValues::m_qseqDataInputFileType, QUESO::McOptionsValues::m_qseqDataOutputAllowedSet, QUESO::McOptionsValues::m_qseqDataOutputFileName, QUESO::McOptionsValues::m_qseqDataOutputFileType, QUESO::McOptionsValues::m_qseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDisplayPeriod, QUESO::McOptionsValues::m_qseqMeasureRunTimes, QUESO::McOptionsValues::m_qseqSize, QUESO::MiscReadDoublesFromString(), queso_deprecated, and QUESO::BaseEnvironment::subDisplayFile().

Referenced by scanOptionsValues().

{
  queso_deprecated();

  if (m_env.allOptionsMap().count(m_option_help)) {
    if (m_env.subDisplayFile()) {
      *m_env.subDisplayFile() << optionsDesc
                              << std::endl;
    }
  }

  if (m_env.allOptionsMap().count(m_option_dataOutputFileName)) {
    m_ov.m_dataOutputFileName = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_dataOutputFileName]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_dataOutputAllowedSet)) {
    m_ov.m_dataOutputAllowedSet.clear();
    std::vector<double> tmpAllow(0,0.);
    std::string inputString = m_env.allOptionsMap()[m_option_dataOutputAllowedSet].as<std::string>();
    MiscReadDoublesFromString(inputString,tmpAllow);

    if (tmpAllow.size() > 0) {
      for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
        m_ov.m_dataOutputAllowedSet.insert((unsigned int) tmpAllow[i]);
      }
    }
  }

  if (m_env.allOptionsMap().count(m_option_pseq_dataOutputPeriod)) {
    m_ov.m_pseqDataOutputPeriod = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_pseq_dataOutputPeriod]).as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_pseq_dataOutputFileName)) {
    m_ov.m_pseqDataOutputFileName = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_pseq_dataOutputFileName]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_pseq_dataOutputFileType)) {
    m_ov.m_pseqDataOutputFileType = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_pseq_dataOutputFileType]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_pseq_dataOutputAllowedSet)) {
    m_ov.m_pseqDataOutputAllowedSet.clear();
    std::vector<double> tmpAllow(0,0.);
    std::string inputString = m_env.allOptionsMap()[m_option_pseq_dataOutputAllowedSet].as<std::string>();
    MiscReadDoublesFromString(inputString,tmpAllow);

    if (tmpAllow.size() > 0) {
      for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
        m_ov.m_pseqDataOutputAllowedSet.insert((unsigned int) tmpAllow[i]);
      }
    }
  }

#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  if (m_env.allOptionsMap().count(m_option_pseq_computeStats)) {
    m_ov.m_pseqComputeStats = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_pseq_computeStats]).as<bool>();
  }
#endif
  if (m_env.allOptionsMap().count(m_option_qseq_dataInputFileName)) {
    m_ov.m_qseqDataInputFileName = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_dataInputFileName]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_dataInputFileType)) {
    m_ov.m_qseqDataInputFileType = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_dataInputFileType]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_size)) {
    m_ov.m_qseqSize = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_size]).as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_displayPeriod)) {
    m_ov.m_qseqDisplayPeriod = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_displayPeriod]).as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_measureRunTimes)) {
    m_ov.m_qseqMeasureRunTimes = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_measureRunTimes]).as<bool>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_dataOutputPeriod)) {
    m_ov.m_qseqDataOutputPeriod = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_dataOutputPeriod]).as<unsigned int>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_dataOutputFileName)) {
    m_ov.m_qseqDataOutputFileName = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_dataOutputFileName]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_dataOutputFileType)) {
    m_ov.m_qseqDataOutputFileType = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_dataOutputFileType]).as<std::string>();
  }

  if (m_env.allOptionsMap().count(m_option_qseq_dataOutputAllowedSet)) {
    m_ov.m_qseqDataOutputAllowedSet.clear();
    std::vector<double> tmpAllow(0,0.);
    std::string inputString = m_env.allOptionsMap()[m_option_qseq_dataOutputAllowedSet].as<std::string>();
    MiscReadDoublesFromString(inputString,tmpAllow);

    if (tmpAllow.size() > 0) {
      for (unsigned int i = 0; i < tmpAllow.size(); ++i) {
        m_ov.m_qseqDataOutputAllowedSet.insert((unsigned int) tmpAllow[i]);
      }
    }
  }

#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  if (m_env.allOptionsMap().count(m_option_qseq_computeStats)) {
    m_ov.m_qseqComputeStats = ((const boost::program_options::variable_value&) m_env.allOptionsMap()[m_option_qseq_computeStats]).as<bool>();
  }
#endif
  return;
}

void QUESO::MonteCarloSGOptions::print

(

std::ostream &

os

)

const

It prints the option values.

Definition at line 667 of file MonteCarloSGOptions.C.

References QUESO::McOptionsValues::m_dataOutputAllowedSet, QUESO::McOptionsValues::m_dataOutputFileName, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_pseq_dataOutputAllowedSet, m_option_pseq_dataOutputFileName, m_option_pseq_dataOutputFileType, m_option_pseq_dataOutputPeriod, m_option_qseq_dataInputFileName, m_option_qseq_dataInputFileType, m_option_qseq_dataOutputAllowedSet, m_option_qseq_dataOutputFileName, m_option_qseq_dataOutputFileType, m_option_qseq_dataOutputPeriod, m_option_qseq_displayPeriod, m_option_qseq_measureRunTimes, m_option_qseq_size, m_ov, QUESO::McOptionsValues::m_pseqDataOutputAllowedSet, QUESO::McOptionsValues::m_pseqDataOutputFileName, QUESO::McOptionsValues::m_pseqDataOutputFileType, QUESO::McOptionsValues::m_pseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDataInputFileName, QUESO::McOptionsValues::m_qseqDataInputFileType, QUESO::McOptionsValues::m_qseqDataOutputAllowedSet, QUESO::McOptionsValues::m_qseqDataOutputFileName, QUESO::McOptionsValues::m_qseqDataOutputFileType, QUESO::McOptionsValues::m_qseqDataOutputPeriod, QUESO::McOptionsValues::m_qseqDisplayPeriod, QUESO::McOptionsValues::m_qseqMeasureRunTimes, QUESO::McOptionsValues::m_qseqSize, and queso_deprecated.

Referenced by QUESO::operator<<().

{
  queso_deprecated();

  os <<         m_option_dataOutputFileName   << " = " << m_ov.m_dataOutputFileName
     << "\n" << m_option_dataOutputAllowedSet << " = ";
  for (std::set<unsigned int>::iterator setIt = m_ov.m_dataOutputAllowedSet.begin(); setIt != m_ov.m_dataOutputAllowedSet.end(); ++setIt) {
    os << *setIt << " ";
  }
  os << "\n" << m_option_pseq_dataOutputPeriod     << " = " << m_ov.m_pseqDataOutputPeriod
     << "\n" << m_option_pseq_dataOutputFileName   << " = " << m_ov.m_pseqDataOutputFileName
     << "\n" << m_option_pseq_dataOutputFileType   << " = " << m_ov.m_pseqDataOutputFileType
     << "\n" << m_option_pseq_dataOutputAllowedSet << " = ";
  for (std::set<unsigned int>::iterator setIt = m_ov.m_pseqDataOutputAllowedSet.begin(); setIt != m_ov.m_pseqDataOutputAllowedSet.end(); ++setIt) {
    os << *setIt << " ";
  }
  os
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
     << "\n" << m_option_pseq_computeStats         << " = " << m_ov.m_pseqComputeStats
#endif
     << "\n" << m_option_qseq_dataInputFileName    << " = " << m_ov.m_qseqDataInputFileName
     << "\n" << m_option_qseq_dataInputFileType    << " = " << m_ov.m_qseqDataInputFileType
     << "\n" << m_option_qseq_size                 << " = " << m_ov.m_qseqSize
     << "\n" << m_option_qseq_displayPeriod        << " = " << m_ov.m_qseqDisplayPeriod
     << "\n" << m_option_qseq_measureRunTimes      << " = " << m_ov.m_qseqMeasureRunTimes
     << "\n" << m_option_qseq_dataOutputPeriod     << " = " << m_ov.m_qseqDataOutputPeriod
     << "\n" << m_option_qseq_dataOutputFileName   << " = " << m_ov.m_qseqDataOutputFileName
     << "\n" << m_option_qseq_dataOutputFileType   << " = " << m_ov.m_qseqDataOutputFileType
     << "\n" << m_option_qseq_dataOutputAllowedSet << " = ";
  for (std::set<unsigned int>::iterator setIt = m_ov.m_qseqDataOutputAllowedSet.begin(); setIt != m_ov.m_qseqDataOutputAllowedSet.end(); ++setIt) {
    os << *setIt << " ";
  }
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  os << "\n" << m_option_qseq_computeStats << " = " << m_ov.m_qseqComputeStats;
#endif

  return;
}

void QUESO::MonteCarloSGOptions::scanOptionsValues

(

)

It scans the option values from the options input file.

Definition at line 489 of file MonteCarloSGOptions.C.

References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_ov, m_prefix, queso_deprecated, queso_require_msg, QUESO::BaseEnvironment::scanInputFileForMyOptions(), and QUESO::BaseEnvironment::subDisplayFile().

{
  queso_deprecated();

#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  queso_require_msg(m_optionsDesc, "m_optionsDesc variable is NULL");

  defineMyOptions                (*m_optionsDesc);
  m_env.scanInputFileForMyOptions(*m_optionsDesc);
  getMyOptionValues              (*m_optionsDesc);
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  if (m_env.subDisplayFile() != NULL) {
    *m_env.subDisplayFile() << "In MonteCarloSGOptions::scanOptionsValues()"
                            << ": after reading values of options with prefix '" << m_prefix
                            << "', state of object is:"
                            << "\n" << *this
                            << std::endl;
  }

  // dakota
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  if (m_ov.m_pseqComputeStats) m_pseqStatisticalOptionsObj =
    new SequenceStatisticalOptions(m_env,m_prefix + "pseq_");
  if (m_ov.m_qseqComputeStats) m_qseqStatisticalOptionsObj =
    new SequenceStatisticalOptions(m_env,m_prefix + "qseq_");
#endif
  return;
}

Member Data Documentation

const BaseEnvironment& QUESO::MonteCarloSGOptions::m_env

private

Definition at line 242 of file MonteCarloSGOptions.h.

Referenced by getMyOptionValues(), MonteCarloSGOptions(), and scanOptionsValues().

std::string QUESO::MonteCarloSGOptions::m_option_dataOutputAllowedSet

private

Definition at line 249 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_dataOutputFileName

private

Definition at line 248 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_help

private

Definition at line 247 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), and getMyOptionValues().

std::string QUESO::MonteCarloSGOptions::m_option_pseq_dataOutputAllowedSet

private

Definition at line 254 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_pseq_dataOutputFileName

private

Definition at line 252 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_pseq_dataOutputFileType

private

Definition at line 253 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_pseq_dataOutputPeriod

private

Definition at line 251 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_dataInputFileName

private

Definition at line 259 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_dataInputFileType

private

Definition at line 260 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_dataOutputAllowedSet

private

Definition at line 267 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_dataOutputFileName

private

Definition at line 265 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_dataOutputFileType

private

Definition at line 266 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_dataOutputPeriod

private

Definition at line 264 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_displayPeriod

private

Definition at line 262 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_measureRunTimes

private

Definition at line 263 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

std::string QUESO::MonteCarloSGOptions::m_option_qseq_size

private

Definition at line 261 of file MonteCarloSGOptions.h.

Referenced by defineMyOptions(), getMyOptionValues(), and print().

boost::program_options::options_description* QUESO::MonteCarloSGOptions::m_optionsDesc

private

Definition at line 244 of file MonteCarloSGOptions.h.

Referenced by scanOptionsValues(), and ~MonteCarloSGOptions().

McOptionsValues QUESO::MonteCarloSGOptions::m_ov

Definition at line 226 of file MonteCarloSGOptions.h.

Referenced by getMyOptionValues(), MonteCarloSGOptions(), print(), and scanOptionsValues().

std::string QUESO::MonteCarloSGOptions::m_prefix

Definition at line 231 of file MonteCarloSGOptions.h.

Referenced by MonteCarloSGOptions(), and scanOptionsValues().

---

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

• src/stats/inc/MonteCarloSGOptions.h
• src/stats/src/MonteCarloSGOptions.C