openstudio::analysis::DakotaParametersFile Class Reference

#include <DakotaParametersFile.hpp>

Public Member Functions
Getters and Queries
int	numVariables () const
int	numContinuousDesignVariables () const
int	numDiscreteDesignIntegerVariables () const
std::vector< double >	continuousDesignVariableValues () const
std::vector< double >	uncertainNormalVariableValues () const
std::vector< double >	uncertainLognormalVariableValues () const
std::vector< double >	uncertainUniformVariableValues () const
std::vector< double >	uncertainLoguniformVariableValues () const
std::vector< double >	uncertainTriangularVariableValues () const
std::vector< double >	uncertainExponentialVariableValues () const
std::vector< double >	uncertainBetaVariableValues () const
std::vector< double >	uncertainGammaVariableValues () const
std::vector< double >	uncertainGumbelVariableValues () const
std::vector< double >	uncertainFrechetVariableValues () const
std::vector< double >	uncertainWeibullVariableValues () const
std::vector< double >	uncertainHistogramBinVariableValues () const
std::vector< int >	discreteDesignIntegerVariableValues () const
std::vector< int >	uncertainPoissonVariableValues () const
std::vector< int >	uncertainBinomialVariableValues () const
std::vector< int >	uncertainNegativeBinomialVariableValues () const
std::vector< int >	uncertainGeometricVariableValues () const
std::vector< int >	uncertainHypergeometricVariableValues () const
std::vector< int >	uncertainHistogramPointVariableValues () const
int	numFunctions () const
DakotaFunctionType	getFunctionType (int i) const
	Return the string description of function i, index starting at 0. More...
bool	getFunctionValueRequired (int i) const
	Returns true if Dakota expects to receive the value of function i, index starting at 0. More...
Type Casting
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...

Static Public Member Functions
static boost::optional < DakotaParametersFile >	load (const openstudio::path &p)
	Loads the DAKOTA parameters input file at p, if possible. More...

Related Functions
(Note that these are not member functions.)
typedef std::vector < DakotaParametersFile >	DakotaParametersFileVector
std::vector< double >	getContinuousUncertainVariableValues (const DakotaParametersFile &params, const UncertaintyDescriptionType &type)
	Returns the variable values for those variables with uncertainty of type. More...
std::vector< int >	getDiscreteUncertainVariableValues (const DakotaParametersFile &params, const UncertaintyDescriptionType &type)
	Returns the variable values for those variables with uncertainty of type. More...
std::vector< QVariant >	getUncertainVariableValues (const DakotaParametersFile &params, const UncertaintyDescriptionType &type)
	Returns the variable values for those variables with uncertainty of type. More...
typedef boost::optional < DakotaParametersFile >	OptionalDakotaParametersFile

Detailed Description

DakotaParametersFile is an interface to the files that DAKOTA drops on the filesystem to indicate that we should create and run a new DataPoint.

Member Function Documentation

template<typename T >

T openstudio::analysis::DakotaParametersFile::cast ( ) const

inline

Cast to type T.

Throws std::bad_cast if object is not a T.

std::vector<double> openstudio::analysis::DakotaParametersFile::continuousDesignVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::discreteDesignIntegerVariableValues

(

)

const

DakotaFunctionType openstudio::analysis::DakotaParametersFile::getFunctionType

(

int

i

)

const

Return the string description of function i, index starting at 0.

bool openstudio::analysis::DakotaParametersFile::getFunctionValueRequired

(

int

i

)

const

Returns true if Dakota expects to receive the value of function i, index starting at 0.

static boost::optional<DakotaParametersFile> openstudio::analysis::DakotaParametersFile::load ( const openstudio::path &  p )

static

Loads the DAKOTA parameters input file at p, if possible.

Otherwise, return value evaluates to false.

int openstudio::analysis::DakotaParametersFile::numContinuousDesignVariables

(

)

const

int openstudio::analysis::DakotaParametersFile::numDiscreteDesignIntegerVariables

(

)

const

int openstudio::analysis::DakotaParametersFile::numFunctions

(

)

const

int openstudio::analysis::DakotaParametersFile::numVariables

(

)

const

template<typename T >

boost::optional<T> openstudio::analysis::DakotaParametersFile::optionalCast ( ) const

inline

Cast to boost::optional<T>.

Return value is boost::none (evaluates to false) if object is not a T.

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainBetaVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::uncertainBinomialVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainExponentialVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainFrechetVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainGammaVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::uncertainGeometricVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainGumbelVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainHistogramBinVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::uncertainHistogramPointVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::uncertainHypergeometricVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainLognormalVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainLoguniformVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::uncertainNegativeBinomialVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainNormalVariableValues

(

)

const

std::vector<int> openstudio::analysis::DakotaParametersFile::uncertainPoissonVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainTriangularVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainUniformVariableValues

(

)

const

std::vector<double> openstudio::analysis::DakotaParametersFile::uncertainWeibullVariableValues

(

)

const

Friends And Related Function Documentation

typedef std::vector<DakotaParametersFile> DakotaParametersFileVector

related

std::vector< double > getContinuousUncertainVariableValues ( const DakotaParametersFile &  params, const UncertaintyDescriptionType &  type  )

related

Returns the variable values for those variables with uncertainty of type.

Throws if type is not applicable to continuous variables.

std::vector< int > getDiscreteUncertainVariableValues ( const DakotaParametersFile &  params, const UncertaintyDescriptionType &  type  )

related

Returns the variable values for those variables with uncertainty of type.

Throws if type is not applicable to discrete variables.

std::vector< QVariant > getUncertainVariableValues ( const DakotaParametersFile &  params, const UncertaintyDescriptionType &  type  )

related

Returns the variable values for those variables with uncertainty of type.

typedef boost::optional<DakotaParametersFile> OptionalDakotaParametersFile

related