 |
OpenStudioCore:analysis |
|
OpenStudioCore:analysis |
#include <OpenStudioAlgorithm.hpp>
Inheritance diagram for openstudio::analysis::OpenStudioAlgorithm:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~OpenStudioAlgorithm () |
Actions | |
| int | createNextIteration (Analysis &analysis) |
| Create the next iteration of work for analysis in the form of constructed but incomplete DataPoints . More... | |
| Public Member Functions inherited from openstudio::analysis::Algorithm | |
| virtual | ~Algorithm () |
| bool | isComplete () const |
| Returns true if the Algorithm ran to completion. More... | |
| bool | failed () const |
| Returns true if the Algorithm ran to completion, but failed in some way. More... | |
| int | iter () const |
| Returns the iteration number, which is incremented during the process of running an Analysis. More... | |
| AlgorithmOptions | options () const |
| AlgorithmOptions shares its data on assignment and copy construction. More... | |
| bool | isCompatibleProblemType (const Problem &problem) const |
| Returns true if Algorithm can operate on problem. 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 < OpenStudioAlgorithm > | OpenStudioAlgorithmVector |
| typedef boost::optional < OpenStudioAlgorithm > | OptionalOpenStudioAlgorithm |
| Related Functions inherited from openstudio::analysis::Algorithm | |
| typedef std::vector< Algorithm > | AlgorithmVector |
| typedef boost::optional < Algorithm > | OptionalAlgorithm |
| Related Functions inherited from openstudio::analysis::AnalysisObject | |
| typedef std::vector < AnalysisObject > | AnalysisObjectVector |
| typedef boost::optional < AnalysisObject > | OptionalAnalysisObject |
Additional Inherited Members | |
| Protected Member Functions inherited from openstudio::analysis::Algorithm | |
| void | reset () |
| Resets algorithm back to its initial state. More... | |
| void | resetComplete () |
OpenStudioAlgorithm is an Algorithm whose logic is directly encoded in the implementation of createNextIteration.
|
inlinevirtual |
| int openstudio::analysis::OpenStudioAlgorithm::createNextIteration | ( | Analysis & | analysis | ) |
Create the next iteration of work for analysis in the form of constructed but incomplete DataPoints .
Throws openstudio::Exception if analysis.algorithm() != *this. Returns the number of DataPoints added.
|
related |
|
related |