 |
OpenStudioCore:analysis |
|
OpenStudioCore:analysis |
#include <Function.hpp>
Inheritance diagram for openstudio::analysis::Function:Public Member Functions | |
Constructors | |
| virtual | ~Function () |
Getters | |
| std::vector< Variable > | variables () const |
| double | getValue (const DataPoint &dataPoint) const |
| 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< Function > | FunctionVector |
| typedef boost::optional< Function > | OptionalFunction |
| Related Functions inherited from openstudio::analysis::AnalysisObject | |
| typedef std::vector < AnalysisObject > | AnalysisObjectVector |
| typedef boost::optional < AnalysisObject > | OptionalAnalysisObject |
Function is an abstract AnalysisObject that registers a set of Variables whose values can be retrieved from a DataPoint, and requires classes derived from it to implement Function::getValue.
Function values are generally evaluated after a DataPoint is simulated, and may be used to direct the course of an Algorithm.
|
inlinevirtual |
| double openstudio::analysis::Function::getValue | ( | const DataPoint & | dataPoint | ) | const |
| std::vector<Variable> openstudio::analysis::Function::variables | ( | ) | const |
|
related |
|
related |