OpenStudioCore:analysis
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::analysis::DiscreteVariable Class Reference

#include <DiscreteVariable.hpp>

+ Inheritance diagram for openstudio::analysis::DiscreteVariable:

Public Member Functions

Constructors and Destructors
virtual ~DiscreteVariable ()
 
Getters and Queries
std::vector< int > validValues (bool selectedOnly) const
 Returns the valid integer values for this variable. More...
 
int numValidValues (bool selectedOnly) const
 
- Public Member Functions inherited from openstudio::analysis::InputVariable
virtual ~InputVariable ()
 
boost::optional
< FileReferenceType > 
inputFileType () const
 
boost::optional
< FileReferenceType > 
outputFileType () const
 
boost::optional
< UncertaintyDescription
uncertaintyDescription () const
 
bool isValid (const QVariant &value) const
 Returns true if value is valid for this Variable. More...
 
bool isValid (const UncertaintyDescription &udesc) const
 Returns true if udesc is valid for this Variable. More...
 
WorkflowStep asWorkflowStep () const
 
bool setUncertaintyDescription (const UncertaintyDescription &udesc)
 
void resetUncertaintyDescription ()
 
runmanager::WorkItem createWorkItem (const QVariant &value, const openstudio::path &rubyIncludeDirectory) const
 Create a runmanager::WorkItem for instantiating this Variable at value. More...
 
- Public Member Functions inherited from openstudio::analysis::Variable
virtual ~Variable ()
 
double getValue (const DataPoint &dataPoint) const
 Get the variable value from a dataPoint. More...
 
- Public Member Functions inherited from openstudio::analysis::AnalysisObject
virtual ~AnalysisObject ()
 
AnalysisObject clone () const
 Deep copy. More...
 
std::string name () const
 
std::string displayName () const
 
std::string description () const
 
openstudio::UUID uuid () const
 
openstudio::UUID versionUUID () const
 
bool isDirty () const
 Returns true if this object has been changed since its dirty flag was last cleared. More...
 
bool operator== (const AnalysisObject &other) const
 Compare impls. More...
 
bool operator!= (const AnalysisObject &other) const
 
bool uuidEqual (const AnalysisObject &other) const
 
bool uuidAndVersionEqual (const AnalysisObject &other) const
 
boost::optional< AnalysisObjectparent () const
 
void setName (const std::string &newName)
 
void setDisplayName (const std::string &newDisplayName)
 
void setDescription (const std::string &newDescription)
 
bool clearDirtyFlag ()
 Call this method to reset the dirty flag of this object and all its children. More...
 
bool connect (const char *signal, const QObject *receiver, const char *slot, Qt::ConnectionType type=Qt::AutoConnection) const
 Connect signal from this AnalysisObject to slot on receiver. More...
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *slot=nullptr) const
 
template<typename T >
cast () const
 Cast to type T. More...
 
template<typename T >
boost::optional< T > optionalCast () const
 Cast to boost::optional<T>. More...
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< DiscreteVariable
DiscreteVariableVector
 
typedef boost::optional
< DiscreteVariable
OptionalDiscreteVariable
 

Detailed Description

A DiscreteVariable is an InputVariable whose value is a finite list of values mappable to a range of integers.

Constructor & Destructor Documentation

virtual openstudio::analysis::DiscreteVariable::~DiscreteVariable ( )
inlinevirtual

Member Function Documentation

int openstudio::analysis::DiscreteVariable::numValidValues ( bool  selectedOnly) const
std::vector<int> openstudio::analysis::DiscreteVariable::validValues ( bool  selectedOnly) const

Returns the valid integer values for this variable.

(All discrete variables are mappable to integers. Some discrete variables allow users to downselect from their overall range.)

Friends And Related Function Documentation

typedef std::vector<DiscreteVariable> DiscreteVariableVector
related
typedef boost::optional<DiscreteVariable> OptionalDiscreteVariable
related