#include <ParameterStudyAlgorithmOptions.hpp>

Inheritance diagram for openstudio::analysis::ParameterStudyAlgorithmOptions:

Public Member Functions
Constructors and Destructors
	ParameterStudyAlgorithmOptions (const ParameterStudyAlgorithmType &algorithmType)
	Every ParameterStudyAlgorithmType has at least one required input. More...

	ParameterStudyAlgorithmOptions (const ParameterStudyAlgorithmType &algorithmType, const std::vector< Attribute > &options)
	Constructor provided for deserialization; not for general use. More...

virtual	~ParameterStudyAlgorithmOptions ()

Getters
ParameterStudyAlgorithmType	algorithmType () const

std::vector< double >	finalPoint () const
	Returns the vector that defines the final point to be sampled. More...

std::vector< double >	stepVector () const
	Returns the vector that defines the step vector for sampling. More...

boost::optional< int >	numSteps () const
	Returns the number of steps to be taken for sampling. More...

std::vector< double >	listOfPoints () const
	Returns the user-defined list of points that are to be sampled. More...

std::vector< int >	stepsPerVariable () const
	Returns the number of steps to be taken for each variable. More...

std::vector< int >	partitions () const
	Returns the number of partitions to be used for each variable. More...

Setters
void	setFinalPoint (const std::vector< double > &value)
	Only applies to ParameterStudyAlgorithmType::vector_parameter_study. More...

void	clearFinalPoint ()

void	setStepVector (const std::vector< double > &value)
	Only applies to ParameterStudyAlgorithmType::vector_parameter_study and ParameterStudyAlgorithmType::centered_parameter_study. More...

void	clearStepVector ()

bool	setNumSteps (const int value)
	Only applies to ParameterStudyAlgorithmType::vector_parameter_study. More...

void	clearNumSteps ()

void	setListOfPoints (const std::vector< double > &value)
	Only applies to ParameterStudyAlgorithmType::list_parameter_study. More...

void	clearListOfPoints ()

bool	setStepsPerVariable (const std::vector< int > &value)
	Only applies to ParameterStudyAlgorithmType::centered_parameter_study. More...

void	clearStepsPerVariable ()

bool	setPartitions (const std::vector< int > &value)
	Only applies to ParameterStudyAlgorithmType::multidim_parameter_study. More...

void	clearPartitions ()

Public Member Functions inherited from openstudio::analysis::DakotaAlgorithmOptions
virtual	~DakotaAlgorithmOptions ()

Public Member Functions inherited from openstudio::analysis::AlgorithmOptions
	AlgorithmOptions ()
	By default, maxIter and maxSims are set to boost::none (no restriction). More...

virtual	~AlgorithmOptions ()

AlgorithmOptions	clone () const

boost::optional< int >	maxIter () const

boost::optional< int >	maxSims () const

std::vector< Attribute >	options () const
	Getter provided for serialization; not for general use. More...

void	setMaxIter (int maxIter)

void	setMaxSims (int maxSims)

void	clearMaxIter ()

void	clearMaxSims ()

template<typename T >
T	cast () const
	Cast to type T. More...

template<typename T >
boost::optional< T >	optionalCast () const
	Cast to boost::optional<T>. More...

Related Functions
(Note that these are not member functions.)
typedef boost::optional < ParameterStudyAlgorithmOptions >	OptionalParameterStudyAlgorithmOptions

typedef std::vector < ParameterStudyAlgorithmOptions >	ParameterStudyAlgorithmOptionsVector

Related Functions inherited from openstudio::analysis::DakotaAlgorithmOptions
typedef std::vector < DakotaAlgorithmOptions >	DakotaAlgorithmOptionsVector

typedef boost::optional < DakotaAlgorithmOptions >	OptionalDakotaAlgorithmOptions

Related Functions inherited from openstudio::analysis::AlgorithmOptions
typedef std::vector < AlgorithmOptions >	AlgorithmOptionsVector

typedef boost::optional < AlgorithmOptions >	OptionalAlgorithmOptions

Additional Inherited Members
Protected Member Functions inherited from openstudio::analysis::AlgorithmOptions
void	setAlgorithm (const Algorithm &algorithm)

QVariant	toVariant () const

Detailed Description

ParameterStudyAlgorithmOptions is a DakotaAlgorithmOptions that defines options specific to ParameterStudyAlgorithm.

Constructor & Destructor Documentation

openstudio::analysis::ParameterStudyAlgorithmOptions::ParameterStudyAlgorithmOptions ( const ParameterStudyAlgorithmType & algorithmType )

explicit

Every ParameterStudyAlgorithmType has at least one required input.

If one of the required inputs is not specified, dakotaInFileDescription() will not write out that option in the .in file, and will log a warning. The required inputs are as follows:

vector_parameter_study requires either finalPoint or stepVector, and numSteps. If you want to use stepVector, then finalPoint must be empty.
list_parameter_study requires listOfPoints.
centered_parameter_study requires stepVector and stepsPerVariable.
multidim_parameter_study requires partitions.

openstudio::analysis::ParameterStudyAlgorithmOptions::ParameterStudyAlgorithmOptions	(	const ParameterStudyAlgorithmType &	algorithmType,
		const std::vector< Attribute > &	options
	)

Constructor provided for deserialization; not for general use.

virtual openstudio::analysis::ParameterStudyAlgorithmOptions::~ParameterStudyAlgorithmOptions ( )

inlinevirtual

Member Function Documentation

ParameterStudyAlgorithmType openstudio::analysis::ParameterStudyAlgorithmOptions::algorithmType ( ) const

void openstudio::analysis::ParameterStudyAlgorithmOptions::clearFinalPoint ( )

void openstudio::analysis::ParameterStudyAlgorithmOptions::clearListOfPoints ( )

void openstudio::analysis::ParameterStudyAlgorithmOptions::clearNumSteps ( )

void openstudio::analysis::ParameterStudyAlgorithmOptions::clearPartitions ( )

void openstudio::analysis::ParameterStudyAlgorithmOptions::clearStepsPerVariable ( )

void openstudio::analysis::ParameterStudyAlgorithmOptions::clearStepVector ( )

std::vector<double> openstudio::analysis::ParameterStudyAlgorithmOptions::finalPoint ( ) const

Returns the vector that defines the final point to be sampled.

Only applies to ParameterStudyAlgorithmType::vector_parameter_study.

std::vector<double> openstudio::analysis::ParameterStudyAlgorithmOptions::listOfPoints ( ) const

Returns the user-defined list of points that are to be sampled.

Only applies to ParameterStudyAlgorithmType::list_parameter_study, and must be specified for this ParameterStudyAlgorithmType.

boost::optional<int> openstudio::analysis::ParameterStudyAlgorithmOptions::numSteps ( ) const

Returns the number of steps to be taken for sampling.

Only applies to ParameterStudyAlgorithmType::vector_parameter_study. This value must be specified to use finalPoint or stepVector.

std::vector<int> openstudio::analysis::ParameterStudyAlgorithmOptions::partitions ( ) const

Returns the number of partitions to be used for each variable.

Only applies to ParameterStudyAlgorithmType::multidim_parameter_study, and must be specified for this ParameterStudyAlgorithmType.

void openstudio::analysis::ParameterStudyAlgorithmOptions::setFinalPoint ( const std::vector< double > & value )

Only applies to ParameterStudyAlgorithmType::vector_parameter_study.

There must be one value for every variable.

void openstudio::analysis::ParameterStudyAlgorithmOptions::setListOfPoints ( const std::vector< double > & value )

Only applies to ParameterStudyAlgorithmType::list_parameter_study.

There must be one value for every variable.

bool openstudio::analysis::ParameterStudyAlgorithmOptions::setNumSteps ( const int value )

Only applies to ParameterStudyAlgorithmType::vector_parameter_study.

Value must be greater than zero.

bool openstudio::analysis::ParameterStudyAlgorithmOptions::setPartitions ( const std::vector< int > & value )

Only applies to ParameterStudyAlgorithmType::multidim_parameter_study.

There must be one value for every variable, and they must be nonnegative.

bool openstudio::analysis::ParameterStudyAlgorithmOptions::setStepsPerVariable ( const std::vector< int > & value )

Only applies to ParameterStudyAlgorithmType::centered_parameter_study.

There must be one value for every variable, and they must be nonnegative.

void openstudio::analysis::ParameterStudyAlgorithmOptions::setStepVector ( const std::vector< double > & value )

Only applies to ParameterStudyAlgorithmType::vector_parameter_study and ParameterStudyAlgorithmType::centered_parameter_study.

There must be one value for every variable.

std::vector<int> openstudio::analysis::ParameterStudyAlgorithmOptions::stepsPerVariable ( ) const

Returns the number of steps to be taken for each variable.

Only applies to ParameterStudyAlgorithmType::centered_parameter_study, and must be specified for this ParameterStudyAlgorithmType.

std::vector<double> openstudio::analysis::ParameterStudyAlgorithmOptions::stepVector ( ) const

Returns the vector that defines the step vector for sampling.

Only applies to ParameterStudyAlgorithmType::vector_parameter_study and ParameterStudyAlgorithmType::centered_parameter_study.

Friends And Related Function Documentation

typedef boost::optional<ParameterStudyAlgorithmOptions> OptionalParameterStudyAlgorithmOptions

Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation