QUESO::McOptionsValues Class Reference

This class provides options for the Monte Carlo sequence generator if no input file is available. More...

#include <MonteCarloSGOptions.h>

Public Member Functions
Constructor/Destructor methods
	McOptionsValues (const SsOptionsValues *alternativePSsOptionsValues, const SsOptionsValues *alternativeQSsOptionsValues)
	McOptionsValues (const SsOptionsValues *alternativePSsOptionsValues, const SsOptionsValues *alternativeQSsOptionsValues, const BaseEnvironment *env, const char *prefix)
	McOptionsValues ()
	Default constructor. More...
	McOptionsValues (const BaseEnvironment *env, const char *prefix)
	Prefix constructor for reading input options from a file. More...
	McOptionsValues (const McOptionsValues &src)
	Copy constructor. More...
virtual	~McOptionsValues ()
	Destructor. More...
Set methods
McOptionsValues &	operator= (const McOptionsValues &rhs)
	Assignment operator; it copies rhs to this. More...

Public Attributes
std::string	m_prefix
std::string	m_help
	If non-empty string, print options and values to output file. More...
std::string	m_dataOutputFileName
std::set< unsigned int >	m_dataOutputAllowedSet
unsigned int	m_pseqDataOutputPeriod
std::string	m_pseqDataOutputFileName
std::string	m_pseqDataOutputFileType
std::set< unsigned int >	m_pseqDataOutputAllowedSet
bool	m_pseqComputeStats
std::string	m_qseqDataInputFileName
std::string	m_qseqDataInputFileType
unsigned int	m_qseqSize
unsigned int	m_qseqDisplayPeriod
bool	m_qseqMeasureRunTimes
unsigned int	m_qseqDataOutputPeriod
std::string	m_qseqDataOutputFileName
std::string	m_qseqDataOutputFileType
std::set< unsigned int >	m_qseqDataOutputAllowedSet
bool	m_qseqComputeStats

Private Member Functions
void	copy (const McOptionsValues &src)
	Copies the option values from src to this. More...
void	checkOptions ()

Private Attributes
BoostInputOptionsParser *	m_parser
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_pseq_computeStats
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
std::string	m_option_qseq_computeStats
SsOptionsValues	m_alternativePSsOptionsValues
SsOptionsValues	m_alternativeQSsOptionsValues

Friends
class	MonteCarloSGOptions
std::ostream &	operator<< (std::ostream &os, const McOptionsValues &obj)

Detailed Description

This class provides options for the Monte Carlo sequence generator if no input file is available.

Monte Carlo sequence generator expects options for its methods. This class provides default values for such options if no input file is available.

Definition at line 79 of file MonteCarloSGOptions.h.

Constructor & Destructor Documentation

QUESO::McOptionsValues::McOptionsValues	(	const SsOptionsValues *	alternativePSsOptionsValues,
		const SsOptionsValues *	alternativeQSsOptionsValues
	)

QUESO::McOptionsValues::McOptionsValues	(	const SsOptionsValues *	alternativePSsOptionsValues,
		const SsOptionsValues *	alternativeQSsOptionsValues,
		const BaseEnvironment *	env,
		const char *	prefix
	)

QUESO::McOptionsValues::McOptionsValues

(

)

Default constructor.

Assigns the default suite of options to the Monte Carlo sequence generator.

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

Prefix constructor for reading input options from a file.

QUESO::McOptionsValues::McOptionsValues

(

const McOptionsValues &

src

)

Copy constructor.

It assigns the same options values from src to this.

Definition at line 275 of file MonteCarloSGOptions.C.

{
  this->copy(src);
}

QUESO::McOptionsValues::~McOptionsValues ( )

virtual

Destructor.

Definition at line 280 of file MonteCarloSGOptions.C.

{
}

Member Function Documentation

void QUESO::McOptionsValues::checkOptions ( )

private

Definition at line 292 of file MonteCarloSGOptions.C.

{
  // Do nothing
}

void QUESO::McOptionsValues::copy ( const McOptionsValues &  src )

private

Copies the option values from src to this.

Definition at line 298 of file MonteCarloSGOptions.C.

References m_alternativePSsOptionsValues, m_alternativeQSsOptionsValues, m_dataOutputAllowedSet, m_dataOutputFileName, QUESO::m_dataOutputFileName, m_pseqComputeStats, m_pseqDataOutputAllowedSet, m_pseqDataOutputFileName, m_pseqDataOutputFileType, m_pseqDataOutputPeriod, m_qseqComputeStats, m_qseqDataInputFileName, m_qseqDataInputFileType, m_qseqDataOutputAllowedSet, m_qseqDataOutputFileName, m_qseqDataOutputFileType, m_qseqDataOutputPeriod, m_qseqDisplayPeriod, m_qseqMeasureRunTimes, and m_qseqSize.

{
  m_dataOutputFileName          = src.m_dataOutputFileName;
  m_dataOutputAllowedSet        = src.m_dataOutputAllowedSet;
  m_pseqDataOutputPeriod        = src.m_pseqDataOutputPeriod;
  m_pseqDataOutputFileName      = src.m_pseqDataOutputFileName;
  m_pseqDataOutputFileType      = src.m_pseqDataOutputFileType;
  m_pseqDataOutputAllowedSet    = src.m_pseqDataOutputAllowedSet;
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_pseqComputeStats            = src.m_pseqComputeStats;
#endif
  m_qseqDataInputFileName       = src.m_qseqDataInputFileName;
  m_qseqDataInputFileType       = src.m_qseqDataInputFileType;
  m_qseqSize                    = src.m_qseqSize;
  m_qseqDisplayPeriod           = src.m_qseqDisplayPeriod;
  m_qseqMeasureRunTimes         = src.m_qseqMeasureRunTimes;
  m_qseqDataOutputPeriod        = src.m_qseqDataOutputPeriod;
  m_qseqDataOutputFileName      = src.m_qseqDataOutputFileName;
  m_qseqDataOutputFileType      = src.m_qseqDataOutputFileType;
  m_qseqDataOutputAllowedSet    = src.m_qseqDataOutputAllowedSet;
#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_qseqComputeStats            = src.m_qseqComputeStats;
#endif

#ifdef QUESO_USES_SEQUENCE_STATISTICAL_OPTIONS
  m_alternativePSsOptionsValues = src.m_alternativePSsOptionsValues;
  m_alternativeQSsOptionsValues = src.m_alternativeQSsOptionsValues;
#endif

  return;
}

McOptionsValues & QUESO::McOptionsValues::operator=

(

const McOptionsValues &

rhs

)

Assignment operator; it copies rhs to this.

Definition at line 285 of file MonteCarloSGOptions.C.

{
  this->copy(rhs);
  return *this;
}

Friends And Related Function Documentation

friend class MonteCarloSGOptions

friend

Definition at line 181 of file MonteCarloSGOptions.h.

std::ostream& operator<< ( std::ostream &  os, const McOptionsValues &  obj  )

friend

Definition at line 330 of file MonteCarloSGOptions.C.

{
#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  os << (*(obj.m_parser)) << std::endl;
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

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

  return os;
}

Member Data Documentation

SsOptionsValues QUESO::McOptionsValues::m_alternativePSsOptionsValues

private

Definition at line 182 of file MonteCarloSGOptions.h.

Referenced by copy().

SsOptionsValues QUESO::McOptionsValues::m_alternativeQSsOptionsValues

private

Definition at line 183 of file MonteCarloSGOptions.h.

Referenced by copy().

std::set<unsigned int> QUESO::McOptionsValues::m_dataOutputAllowedSet

Definition at line 119 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_dataOutputFileName

Definition at line 118 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_help

If non-empty string, print options and values to output file.

Definition at line 116 of file MonteCarloSGOptions.h.

std::string QUESO::McOptionsValues::m_option_dataOutputAllowedSet

private

Definition at line 149 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_dataOutputFileName

private

Definition at line 148 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_help

private

Definition at line 147 of file MonteCarloSGOptions.h.

std::string QUESO::McOptionsValues::m_option_pseq_computeStats

private

Definition at line 156 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_pseq_dataOutputAllowedSet

private

Definition at line 154 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_pseq_dataOutputFileName

private

Definition at line 152 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_pseq_dataOutputFileType

private

Definition at line 153 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_pseq_dataOutputPeriod

private

Definition at line 151 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_computeStats

private

Definition at line 169 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_dataInputFileName

private

Definition at line 159 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_dataInputFileType

private

Definition at line 160 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_dataOutputAllowedSet

private

Definition at line 167 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_dataOutputFileName

private

Definition at line 165 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_dataOutputFileType

private

Definition at line 166 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_dataOutputPeriod

private

Definition at line 164 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_displayPeriod

private

Definition at line 162 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_measureRunTimes

private

Definition at line 163 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_option_qseq_size

private

Definition at line 161 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

BoostInputOptionsParser* QUESO::McOptionsValues::m_parser

private

Definition at line 144 of file MonteCarloSGOptions.h.

Referenced by QUESO::operator<<().

std::string QUESO::McOptionsValues::m_prefix

Definition at line 113 of file MonteCarloSGOptions.h.

bool QUESO::McOptionsValues::m_pseqComputeStats

Definition at line 126 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::set<unsigned int> QUESO::McOptionsValues::m_pseqDataOutputAllowedSet

Definition at line 124 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_pseqDataOutputFileName

Definition at line 122 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_pseqDataOutputFileType

Definition at line 123 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

unsigned int QUESO::McOptionsValues::m_pseqDataOutputPeriod

Definition at line 121 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

bool QUESO::McOptionsValues::m_qseqComputeStats

Definition at line 139 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_qseqDataInputFileName

Definition at line 129 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_qseqDataInputFileType

Definition at line 130 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::set<unsigned int> QUESO::McOptionsValues::m_qseqDataOutputAllowedSet

Definition at line 137 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_qseqDataOutputFileName

Definition at line 135 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

std::string QUESO::McOptionsValues::m_qseqDataOutputFileType

Definition at line 136 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

unsigned int QUESO::McOptionsValues::m_qseqDataOutputPeriod

Definition at line 134 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

unsigned int QUESO::McOptionsValues::m_qseqDisplayPeriod

Definition at line 132 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

bool QUESO::McOptionsValues::m_qseqMeasureRunTimes

Definition at line 133 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

unsigned int QUESO::McOptionsValues::m_qseqSize

Definition at line 131 of file MonteCarloSGOptions.h.

Referenced by copy(), and QUESO::operator<<().

---

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

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