#include <LognormalDistribution.hpp>

Inheritance diagram for openstudio::analysis::LognormalDistribution:

Public Member Functions
Constructors and Destructors
	LognormalDistribution ()
	This distribution requires one of the three following pairs: mean and standardDeviation, mean and errorFactor, or lambda and zeta. More...

virtual	~LognormalDistribution ()

Getters
boost::optional< double >	mean () const

boost::optional< double >	standardDeviation () const

boost::optional< double >	errorFactor () const

boost::optional< double >	lambda () const

boost::optional< double >	zeta () const

boost::optional< double >	lowerBound () const

boost::optional< double >	upperBound () const

Setters
bool	setMean (double value)

void	resetMean ()

bool	setStandardDeviation (double value)

void	resetStandardDeviation ()

bool	setErrorFactor (double value)

void	resetErrorFactor ()

void	setLambda (double value)

void	resetLambda ()

bool	setZeta (double value)

void	resetZeta ()

bool	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
	LognormalDistribution (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

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

Constructor & Destructor Documentation

openstudio::analysis::LognormalDistribution::LognormalDistribution ( )

This distribution requires one of the three following pairs: mean and standardDeviation, mean and errorFactor, or lambda and zeta.

The default constructor creates a distribution with mean 1 and standard deviation of 1.

virtual openstudio::analysis::LognormalDistribution::~LognormalDistribution ( )

inlinevirtual

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

explicitprotected

boost::optional<double> openstudio::analysis::LognormalDistribution::errorFactor ( ) const

boost::optional<double> openstudio::analysis::LognormalDistribution::lambda ( ) const

boost::optional<double> openstudio::analysis::LognormalDistribution::lowerBound ( ) const

boost::optional<double> openstudio::analysis::LognormalDistribution::mean ( ) const

void openstudio::analysis::LognormalDistribution::resetErrorFactor ( )

void openstudio::analysis::LognormalDistribution::resetLambda ( )

void openstudio::analysis::LognormalDistribution::resetLowerBound ( )

void openstudio::analysis::LognormalDistribution::resetMean ( )

void openstudio::analysis::LognormalDistribution::resetStandardDeviation ( )

void openstudio::analysis::LognormalDistribution::resetUpperBound ( )

void openstudio::analysis::LognormalDistribution::resetZeta ( )

bool openstudio::analysis::LognormalDistribution::setErrorFactor ( double value )

void openstudio::analysis::LognormalDistribution::setLambda ( double value )

bool openstudio::analysis::LognormalDistribution::setLowerBound ( double value )

bool openstudio::analysis::LognormalDistribution::setMean ( double value )

bool openstudio::analysis::LognormalDistribution::setStandardDeviation ( double value )

void openstudio::analysis::LognormalDistribution::setUpperBound ( double value )

bool openstudio::analysis::LognormalDistribution::setZeta ( double value )

boost::optional<double> openstudio::analysis::LognormalDistribution::standardDeviation ( ) const

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

static

boost::optional<double> openstudio::analysis::LognormalDistribution::upperBound ( ) const

boost::optional<double> openstudio::analysis::LognormalDistribution::zeta ( ) const