 |
OpenStudioCore:analysis |
|
OpenStudioCore:analysis |
#include <InputVariable.hpp>
Inheritance diagram for openstudio::analysis::InputVariable:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~InputVariable () |
Getters and Queries | |
| 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 |
Setters | |
| bool | setUncertaintyDescription (const UncertaintyDescription &udesc) |
| void | resetUncertaintyDescription () |
Actions | |
| 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 < 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 |
|
inlinevirtual |
| WorkflowStep openstudio::analysis::InputVariable::asWorkflowStep | ( | ) | const |
| runmanager::WorkItem openstudio::analysis::InputVariable::createWorkItem | ( | const QVariant & | value, |
| const openstudio::path & | rubyIncludeDirectory | ||
| ) | const |
Create a runmanager::WorkItem for instantiating this Variable at value.
Will throw an openstudio::Exception if value is invalid for the variable.
| boost::optional<FileReferenceType> openstudio::analysis::InputVariable::inputFileType | ( | ) | const |
| bool openstudio::analysis::InputVariable::isValid | ( | const QVariant & | value | ) | const |
Returns true if value is valid for this Variable.
If returns false, createWorkItem(value) should throw.
| bool openstudio::analysis::InputVariable::isValid | ( | const UncertaintyDescription & | udesc | ) | const |
Returns true if udesc is valid for this Variable.
If returns false, setUncertaintyDescription(udesc) will fail.
| boost::optional<FileReferenceType> openstudio::analysis::InputVariable::outputFileType | ( | ) | const |
| void openstudio::analysis::InputVariable::resetUncertaintyDescription | ( | ) |
| bool openstudio::analysis::InputVariable::setUncertaintyDescription | ( | const UncertaintyDescription & | udesc | ) |
| boost::optional<UncertaintyDescription> openstudio::analysis::InputVariable::uncertaintyDescription | ( | ) | const |
|
related |
|
related |