 |
OpenStudioCore:analysis |
|
OpenStudioCore:analysis |
#include <RubyContinuousVariable.hpp>
Inheritance diagram for openstudio::analysis::RubyContinuousVariable:Public Member Functions | |
Constructors and Destructors | |
| RubyContinuousVariable (const std::string &name, const ruleset::OSArgument &argument, const RubyMeasure &measure) | |
| Construct from argument and measure. More... | |
| RubyContinuousVariable (const UUID &uuid, const UUID &versionUUID, const std::string &name, const std::string &displayName, const std::string &description, const boost::optional< UncertaintyDescription > &udesc, boost::optional< double > minimum, boost::optional< double > maximum, boost::optional< double > increment, boost::optional< int > nSteps, const ruleset::OSArgument &argument, const RubyMeasure &measure) | |
| Constructor provided for deserialization; not for general use. More... | |
| virtual | ~RubyContinuousVariable () |
Getters and Queries | |
| ruleset::OSArgument | argument () const |
| RubyMeasure | measure () const |
| RubyMeasure | perturbation () const |
Setters | |
| void | setArgument (const ruleset::OSArgument &argument) |
| bool | setRubyMeasure (const RubyMeasure &measure) |
| bool | setRubyPerturbation (const RubyMeasure &measure) |
| Public Member Functions inherited from openstudio::analysis::ContinuousVariable | |
| virtual | ~ContinuousVariable () |
| 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... | |
| 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 () |
| 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 boost::optional < RubyContinuousVariable > | OptionalRubyContinuousVariable |
| typedef std::vector < RubyContinuousVariable > | RubyContinuousVariableVector |
| Related Functions inherited from openstudio::analysis::ContinuousVariable | |
| 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 |
| openstudio::analysis::RubyContinuousVariable::RubyContinuousVariable | ( | const std::string & | name, |
| const ruleset::OSArgument & | argument, | ||
| const RubyMeasure & | measure | ||
| ) |
Construct from argument and measure.
The RubyMeasure should not yet have argument set. It should have all fixed (non-variable) arguments set.
| openstudio::analysis::RubyContinuousVariable::RubyContinuousVariable | ( | const UUID & | uuid, |
| const UUID & | versionUUID, | ||
| const std::string & | name, | ||
| const std::string & | displayName, | ||
| const std::string & | description, | ||
| const boost::optional< UncertaintyDescription > & | udesc, | ||
| boost::optional< double > | minimum, | ||
| boost::optional< double > | maximum, | ||
| boost::optional< double > | increment, | ||
| boost::optional< int > | nSteps, | ||
| const ruleset::OSArgument & | argument, | ||
| const RubyMeasure & | measure | ||
| ) |
Constructor provided for deserialization; not for general use.
|
inlinevirtual |
| ruleset::OSArgument openstudio::analysis::RubyContinuousVariable::argument | ( | ) | const |
| RubyMeasure openstudio::analysis::RubyContinuousVariable::measure | ( | ) | const |
| RubyMeasure openstudio::analysis::RubyContinuousVariable::perturbation | ( | ) | const |
| void openstudio::analysis::RubyContinuousVariable::setArgument | ( | const ruleset::OSArgument & | argument | ) |
| bool openstudio::analysis::RubyContinuousVariable::setRubyMeasure | ( | const RubyMeasure & | measure | ) |
| bool openstudio::analysis::RubyContinuousVariable::setRubyPerturbation | ( | const RubyMeasure & | measure | ) |
|
related |
|
related |