openstudio::analysis::NormalDistribution Class Reference

#include <NormalDistribution.hpp>

Inheritance diagram for openstudio::analysis::NormalDistribution:

Public Member Functions
Constructors and Destructors
	NormalDistribution ()
	Returns a standard normal distribution (mean 0, standardDeviation 1). More...
	NormalDistribution (double mean, double standardDeviation)
virtual	~NormalDistribution ()
Getters
double	mean () const
double	standardDeviation () const
boost::optional< double >	lowerBound () const
boost::optional< double >	upperBound () const
Setters
void	setMean (double value)
bool	setStandardDeviation (double value)
void	setLowerBound (double value)
void	resetLowerBound ()
void	setUpperBound (double value)
void	resetUpperBound ()
Public Member Functions inherited from openstudio::analysis::UncertaintyDescription
virtual	~UncertaintyDescription ()
UncertaintyDescription	clone () const
UncertaintyDescriptionType	type () const
void	restoreDefaults ()
	Restores the default options for this UncertaintyDescription and its type(). More...
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 UncertaintyDescriptionType	type ()
Static Public Member Functions inherited from openstudio::analysis::UncertaintyDescription
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 Member Functions
	NormalDistribution (std::shared_ptr< detail::UncertaintyDescription_Impl > impl)
Protected Member Functions inherited from openstudio::analysis::UncertaintyDescription
	UncertaintyDescription (std::shared_ptr< detail::UncertaintyDescription_Impl > impl)

Additional Inherited Members
Protected Types inherited from openstudio::analysis::UncertaintyDescription
typedef detail::UncertaintyDescription_Impl	ImplType
Related Functions inherited from openstudio::analysis::UncertaintyDescription
typedef boost::optional < UncertaintyDescription >	OptionalUncertaintyDescription

Detailed Description

NormalDistribution is an UncertaintyDescription that can apply aleatory uncertainty to a continuous variable.

Constructor & Destructor Documentation

openstudio::analysis::NormalDistribution::NormalDistribution

(

)

Returns a standard normal distribution (mean 0, standardDeviation 1).

openstudio::analysis::NormalDistribution::NormalDistribution	(	double	mean,
		double	standardDeviation
	)

virtual openstudio::analysis::NormalDistribution::~NormalDistribution ( )

inlinevirtual

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

explicitprotected

Member Function Documentation

boost::optional<double> openstudio::analysis::NormalDistribution::lowerBound

(

)

const

double openstudio::analysis::NormalDistribution::mean

(

)

const

void openstudio::analysis::NormalDistribution::resetLowerBound

(

)

void openstudio::analysis::NormalDistribution::resetUpperBound

(

)

void openstudio::analysis::NormalDistribution::setLowerBound

(

double

value

)

void openstudio::analysis::NormalDistribution::setMean

(

double

value

)

bool openstudio::analysis::NormalDistribution::setStandardDeviation

(

double

value

)

void openstudio::analysis::NormalDistribution::setUpperBound

(

double

value

)

double openstudio::analysis::NormalDistribution::standardDeviation

(

)

const

static UncertaintyDescriptionType openstudio::analysis::NormalDistribution::type ( )

static

boost::optional<double> openstudio::analysis::NormalDistribution::upperBound

(

)

const