OpenStudioCore:analysis
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Protected Member Functions | List of all members
openstudio::analysis::HypergeometricDistribution Class Reference

#include <HypergeometricDistribution.hpp>

+ Inheritance diagram for openstudio::analysis::HypergeometricDistribution:

Public Member Functions

Constructors and Destructors
 HypergeometricDistribution ()
 Returns a hypergeometric distribution with total population of 20, selected population of 10, and number of draws of 10. More...
 
 HypergeometricDistribution (int totalPopulation, int selectedPopulation, int numDrawn)
 
virtual ~HypergeometricDistribution ()
 
Getters
int totalPopulation () const
 
int selectedPopulation () const
 
int numDrawn () const
 
Setters
bool setTotalPopulation (int value)
 
bool setSelectedPopulation (int value)
 
bool setNumDrawn (int value)
 
- 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 >
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

 HypergeometricDistribution (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
 

Detailed Description

HypergeometricDistribution is an UncertaintyDescription that can apply aleatory uncertainty to a discrete variable.

Constructor & Destructor Documentation

openstudio::analysis::HypergeometricDistribution::HypergeometricDistribution ( )

Returns a hypergeometric distribution with total population of 20, selected population of 10, and number of draws of 10.

openstudio::analysis::HypergeometricDistribution::HypergeometricDistribution ( int  totalPopulation,
int  selectedPopulation,
int  numDrawn 
)
virtual openstudio::analysis::HypergeometricDistribution::~HypergeometricDistribution ( )
inlinevirtual
openstudio::analysis::HypergeometricDistribution::HypergeometricDistribution ( std::shared_ptr< detail::UncertaintyDescription_Impl >  impl)
explicitprotected

Member Function Documentation

int openstudio::analysis::HypergeometricDistribution::numDrawn ( ) const
int openstudio::analysis::HypergeometricDistribution::selectedPopulation ( ) const
bool openstudio::analysis::HypergeometricDistribution::setNumDrawn ( int  value)
bool openstudio::analysis::HypergeometricDistribution::setSelectedPopulation ( int  value)
bool openstudio::analysis::HypergeometricDistribution::setTotalPopulation ( int  value)
int openstudio::analysis::HypergeometricDistribution::totalPopulation ( ) const
static UncertaintyDescriptionType openstudio::analysis::HypergeometricDistribution::type ( )
static