 |
OpenStudioCore:analysis |
|
OpenStudioCore:analysis |
#include <SamplingAlgorithm.hpp>
Inheritance diagram for openstudio::analysis::SamplingAlgorithm:Public Member Functions | |
Constructors and Destructors | |
| SamplingAlgorithm (const SamplingAlgorithmOptions &options) | |
| Construct from options. More... | |
| SamplingAlgorithm (const UUID &uuid, const UUID &versionUUID, const std::string &displayName, const std::string &description, bool complete, bool failed, int iter, const SamplingAlgorithmOptions &options, const boost::optional< FileReference > &restartFileReference, const boost::optional< FileReference > &outFileReference, const boost::optional< openstudio::runmanager::Job > &job) | |
| Constructor provided for deserialization; not for general use. More... | |
| virtual | ~SamplingAlgorithm () |
Getters and Queries | |
| SamplingAlgorithmOptions | samplingAlgorithmOptions () const |
| Public Member Functions inherited from openstudio::analysis::DakotaAlgorithm | |
| virtual | ~DakotaAlgorithm () |
| bool | requiresContinuousVariables () const |
| Returns true if the algorithm requires continuous variables. More... | |
| bool | isCompatible (const UncertaintyDescriptionType &udescType) const |
| boost::optional< FileReference > | restartFileReference () const |
| Returns a reference to the DAKOTA restart file, if possible. More... | |
| boost::optional< FileReference > | outFileReference () const |
| Returns a reference to the DAKOTA out file, if possible. More... | |
| boost::optional < openstudio::runmanager::Job > | job () const |
| Returns the RunManager job if possible. More... | |
| std::string | dakotaInFileDescription () const |
| Returns a string that describes this algorithm, including its options, in DAKOTA .in file syntax. More... | |
| boost::optional< DataPoint > | createNextDataPoint (Analysis &analysis, const DakotaParametersFile ¶ms) |
| Tries to create a new data point from dakotaParametersFile, returning the new point, or an equivalent point already present in analysis. 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 boost::optional < SamplingAlgorithm > | OptionalSamplingAlgorithm |
| typedef std::vector < SamplingAlgorithm > | SamplingAlgorithmVector |
| Related Functions inherited from openstudio::analysis::DakotaAlgorithm | |
| typedef std::vector < DakotaAlgorithm > | DakotaAlgorithmVector |
| typedef boost::optional < DakotaAlgorithm > | OptionalDakotaAlgorithm |
| 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::DakotaAlgorithm | |
| void | markComplete () |
| void | markFailed () |
| void | resetFailed () |
| void | setOutFileReference (const FileReference &file) |
| Called after Dakota job is constructed. More... | |
| void | setRestartFileReference (const FileReference &file) |
| Called after Dakota job is constructed. More... | |
| Protected Member Functions inherited from openstudio::analysis::Algorithm | |
| void | reset () |
| Resets algorithm back to its initial state. More... | |
| void | resetComplete () |
SamplingAlgorithm is a DakotaAlgorithm that implements dakotaInFileDescription so as to specify a particular Sampling method and related options.
The purpose of SamplingAlgorithm is not so much to provide sampling algorithms (the sampling algorithms available are also available in DDACE), but to enable proper sampling from a number of UncertaintyDescriptions.
|
explicit |
Construct from options.
| openstudio::analysis::SamplingAlgorithm::SamplingAlgorithm | ( | const UUID & | uuid, |
| const UUID & | versionUUID, | ||
| const std::string & | displayName, | ||
| const std::string & | description, | ||
| bool | complete, | ||
| bool | failed, | ||
| int | iter, | ||
| const SamplingAlgorithmOptions & | options, | ||
| const boost::optional< FileReference > & | restartFileReference, | ||
| const boost::optional< FileReference > & | outFileReference, | ||
| const boost::optional< openstudio::runmanager::Job > & | job | ||
| ) |
Constructor provided for deserialization; not for general use.
|
inlinevirtual |
| SamplingAlgorithmOptions openstudio::analysis::SamplingAlgorithm::samplingAlgorithmOptions | ( | ) | const |
|
related |
|
related |