openstudio::analysis::UncertaintyDescription Class Reference

#include <UncertaintyDescription.hpp>

Inheritance diagram for openstudio::analysis::UncertaintyDescription:

Public Member Functions
Constructors and Destructors
virtual	~UncertaintyDescription ()
UncertaintyDescription	clone () const
Getters and Queries
UncertaintyDescriptionType	type () const
Setters
void	restoreDefaults ()
	Restores the default options for this UncertaintyDescription and its type(). More...
Type Casting
template<typename T >
T	cast () const
	Casts the UncertaintyDescription to type T, if possible. More...
template<typename T >
boost::optional< T >	optionalCast () const

Static Public Member Functions
static std::vector < UncertaintyDescriptionType >	validTypes (const VariableValueType &variableValueType)
	Returns all the UncertaintyDescriptionTypes that are applicable to variableValueType (VariableValueType::Continuous or VariableValueType::Discrete). More...
static std::vector < UncertaintyDescriptionType >	validTypes (const VariableValueType &variableValueType, const UncertaintyType &uncertaintyType)
	Returns all the UncertaintyDescriptionTypes that are applicable to the specified combination of variableValueType (VariableValueType::Continuous or VariableValueType::Discrete) and uncertaintyType (UncertaintyType::Aleatory or UncertaintyType::Epistemic). More...

Protected Types
typedef detail::UncertaintyDescription_Impl	ImplType

Protected Member Functions
	UncertaintyDescription (std::shared_ptr< detail::UncertaintyDescription_Impl > impl)

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

Detailed Description

UncertaintyDescription is an abstract base class that can be used to append uncertainty information to a Variable.

At this time, such descriptions are only used if the variables are sampled using SamplingAlgorithm (which is available through DAKOTA).

Member Typedef Documentation

typedef detail::UncertaintyDescription_Impl openstudio::analysis::UncertaintyDescription::ImplType

protected

Constructor & Destructor Documentation

virtual openstudio::analysis::UncertaintyDescription::~UncertaintyDescription ( )

inlinevirtual

openstudio::analysis::UncertaintyDescription::UncertaintyDescription ( std::shared_ptr< detail::UncertaintyDescription_Impl >  impl )

explicitprotected

Member Function Documentation

template<typename T >

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

inline

Casts the UncertaintyDescription to type T, if possible.

All descriptions can be cast to GenericUncertaintyDescription, which provides a unified interface for all types. Otherwise, the cast will only succeed if type() == T::type().

UncertaintyDescription openstudio::analysis::UncertaintyDescription::clone

(

)

const

template<typename T >

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

inline

void openstudio::analysis::UncertaintyDescription::restoreDefaults

(

)

Restores the default options for this UncertaintyDescription and its type().

UncertaintyDescriptionType openstudio::analysis::UncertaintyDescription::type

(

)

const

static std::vector<UncertaintyDescriptionType> openstudio::analysis::UncertaintyDescription::validTypes ( const VariableValueType &  variableValueType )

static

Returns all the UncertaintyDescriptionTypes that are applicable to variableValueType (VariableValueType::Continuous or VariableValueType::Discrete).

static std::vector<UncertaintyDescriptionType> openstudio::analysis::UncertaintyDescription::validTypes ( const VariableValueType &  variableValueType, const UncertaintyType &  uncertaintyType  )

static

Returns all the UncertaintyDescriptionTypes that are applicable to the specified combination of variableValueType (VariableValueType::Continuous or VariableValueType::Discrete) and uncertaintyType (UncertaintyType::Aleatory or UncertaintyType::Epistemic).

Friends And Related Function Documentation

typedef boost::optional<UncertaintyDescription> OptionalUncertaintyDescription

related