 |
OpenStudioCore:analysis |
|
OpenStudioCore:analysis |
#include <ContinuousVariable.hpp>
Inheritance diagram for openstudio::analysis::ContinuousVariable:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~ContinuousVariable () |
Getters and Queries | |
| boost::optional< double > | minimum () const |
| Returns the minimum, or lower bound, on the ContinuousVariable, if it exists. More... | |
| boost::optional< double > | maximum () const |
| Returns the maximum, or upper bound, on the ContinuousVariable, if it exists. More... | |
| boost::optional< double > | increment () const |
| Returns the increment to be applied to this ContinuousVariable when using minimum() and maximum() to create discrete values. More... | |
| boost::optional< int > | nSteps () const |
| Returns the number of steps to be used with minimum() and maximum() to create discrete values. More... | |
| bool | isFeasible (double value) const |
| Returns true if value in [minimum,maximum]. More... | |
| std::vector< double > | incrementalValues () const |
| Returns a vector of incremental values, if minimum() && maximum() && (increment() || nSteps()). More... | |
Setters | |
| void | setMinimum (double minimum) |
| void | setMaximum (double maximum) |
| void | setIncrement (double increment) |
| Sets increment and nullifies nSteps. More... | |
| void | setNSteps (int nSteps) |
| Sets nSteps and nullifies increment. More... | |
| void | clearMinimum () |
| void | clearMaximum () |
| void | clearIncrement () |
| void | clearNSteps () |
Actions | |
| boost::optional< double > | truncate (double value) const |
| Truncates value to [minimum,maximum]. More... | |
| 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< AnalysisObject > | parent () 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 > | |
| 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 < ContinuousVariable > | ContinuousVariableVector |
| typedef boost::optional < ContinuousVariable > | OptionalContinuousVariable |
| Related Functions inherited from openstudio::analysis::InputVariable | |
| typedef std::vector < InputVariable > | InputVariableVector |
| typedef boost::optional < InputVariable > | OptionalInputVariable |
| Related Functions inherited from openstudio::analysis::Variable | |
| typedef boost::optional< Variable > | OptionalVariable |
| typedef std::vector< Variable > | VariableVector |
| Related Functions inherited from openstudio::analysis::AnalysisObject | |
| typedef std::vector < AnalysisObject > | AnalysisObjectVector |
| typedef boost::optional < AnalysisObject > | OptionalAnalysisObject |
A ContinuousVariable is an InputVariable whose value is a real number, perhaps restricted to lie within some bounds.
|
inlinevirtual |
| void openstudio::analysis::ContinuousVariable::clearIncrement | ( | ) |
| void openstudio::analysis::ContinuousVariable::clearMaximum | ( | ) |
| void openstudio::analysis::ContinuousVariable::clearMinimum | ( | ) |
| void openstudio::analysis::ContinuousVariable::clearNSteps | ( | ) |
| boost::optional<double> openstudio::analysis::ContinuousVariable::increment | ( | ) | const |
Returns the increment to be applied to this ContinuousVariable when using minimum() and maximum() to create discrete values.
| std::vector<double> openstudio::analysis::ContinuousVariable::incrementalValues | ( | ) | const |
| bool openstudio::analysis::ContinuousVariable::isFeasible | ( | double | value | ) | const |
Returns true if value in [minimum,maximum].
| boost::optional<double> openstudio::analysis::ContinuousVariable::maximum | ( | ) | const |
Returns the maximum, or upper bound, on the ContinuousVariable, if it exists.
| boost::optional<double> openstudio::analysis::ContinuousVariable::minimum | ( | ) | const |
Returns the minimum, or lower bound, on the ContinuousVariable, if it exists.
| boost::optional<int> openstudio::analysis::ContinuousVariable::nSteps | ( | ) | const |
| void openstudio::analysis::ContinuousVariable::setIncrement | ( | double | increment | ) |
Sets increment and nullifies nSteps.
| void openstudio::analysis::ContinuousVariable::setMaximum | ( | double | maximum | ) |
| void openstudio::analysis::ContinuousVariable::setMinimum | ( | double | minimum | ) |
| void openstudio::analysis::ContinuousVariable::setNSteps | ( | int | nSteps | ) |
Sets nSteps and nullifies increment.
| boost::optional<double> openstudio::analysis::ContinuousVariable::truncate | ( | double | value | ) | const |
Truncates value to [minimum,maximum].
If minimum > maximum, returns boost::none.
|
related |
|
related |