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

#include <HistogramPointDistribution.hpp>

+ Inheritance diagram for openstudio::analysis::HistogramPointDistribution:

Public Member Functions

Constructors and Destructors
 HistogramPointDistribution ()
 Returns a histogram point distribution with abscissas of [0,1] and counts of [1,1]. More...
 
 HistogramPointDistribution (std::vector< double > abscissas, std::vector< double > counts)
 
virtual ~HistogramPointDistribution ()
 
Getters
std::vector< double > abscissas () const
 
std::vector< double > counts () const
 
boost::optional< int > numPairs () const
 
Setters
bool setAbscissas (const std::vector< double > &value)
 
bool setCounts (const std::vector< double > &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

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

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

Constructor & Destructor Documentation

openstudio::analysis::HistogramPointDistribution::HistogramPointDistribution ( )

Returns a histogram point distribution with abscissas of [0,1] and counts of [1,1].

openstudio::analysis::HistogramPointDistribution::HistogramPointDistribution ( std::vector< double >  abscissas,
std::vector< double >  counts 
)
virtual openstudio::analysis::HistogramPointDistribution::~HistogramPointDistribution ( )
inlinevirtual
openstudio::analysis::HistogramPointDistribution::HistogramPointDistribution ( std::shared_ptr< detail::UncertaintyDescription_Impl >  impl)
explicitprotected

Member Function Documentation

std::vector<double> openstudio::analysis::HistogramPointDistribution::abscissas ( ) const
std::vector<double> openstudio::analysis::HistogramPointDistribution::counts ( ) const
boost::optional<int> openstudio::analysis::HistogramPointDistribution::numPairs ( ) const
bool openstudio::analysis::HistogramPointDistribution::setAbscissas ( const std::vector< double > &  value)
bool openstudio::analysis::HistogramPointDistribution::setCounts ( const std::vector< double > &  value)
static UncertaintyDescriptionType openstudio::analysis::HistogramPointDistribution::type ( )
static