openstudio::analysis::DesignOfExperiments Class Reference

#include <DesignOfExperiments.hpp>

Inheritance diagram for openstudio::analysis::DesignOfExperiments:

Public Member Functions
Constructors and Destructors
	DesignOfExperiments (const DesignOfExperimentsOptions &options)
	DesignOfExperiments (const UUID &uuid, const UUID &versionUUID, const std::string &displayName, const std::string &description, bool complete, bool failed, int iter, const DesignOfExperimentsOptions &options)
	Constructor provided for deserialization; not for general use. More...
virtual	~DesignOfExperiments ()
Getters and Queries
DesignOfExperimentsOptions	designOfExperimentsOptions () const
Public Member Functions inherited from openstudio::analysis::OpenStudioAlgorithm
virtual	~OpenStudioAlgorithm ()
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...

Static Public Member Functions
static std::string	standardName ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < DesignOfExperiments >	DesignOfExperimentsVector
typedef boost::optional < DesignOfExperiments >	OptionalDesignOfExperiments
Related Functions inherited from openstudio::analysis::OpenStudioAlgorithm
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 ()

Detailed Description

DesignOfExperiments is an OpenStudioAlgorithm.

Currently, DesignOfExperiments may be used to perform full mesh parametric analyses on Problems for which Problem::allVariablesAreDiscrete. DesignOfExperiments::createNextIteration adds all DataPoints at once, in one batch.

Constructor & Destructor Documentation

openstudio::analysis::DesignOfExperiments::DesignOfExperiments ( const DesignOfExperimentsOptions &  options )

explicit

openstudio::analysis::DesignOfExperiments::DesignOfExperiments	(	const UUID &	uuid,
		const UUID &	versionUUID,
		const std::string &	displayName,
		const std::string &	description,
		bool	complete,
		bool	failed,
		int	iter,
		const DesignOfExperimentsOptions &	options
	)

Constructor provided for deserialization; not for general use.

virtual openstudio::analysis::DesignOfExperiments::~DesignOfExperiments ( )

inlinevirtual

Member Function Documentation

DesignOfExperimentsOptions openstudio::analysis::DesignOfExperiments::designOfExperimentsOptions

(

)

const

static std::string openstudio::analysis::DesignOfExperiments::standardName ( )

static

Friends And Related Function Documentation

typedef std::vector<DesignOfExperiments> DesignOfExperimentsVector

related

typedef boost::optional<DesignOfExperiments> OptionalDesignOfExperiments

related