openstudio::analysis::AlgorithmOptions Class Reference

#include <AlgorithmOptions.hpp>

Inheritance diagram for openstudio::analysis::AlgorithmOptions:

Public Member Functions
Constructors and Destructors
	AlgorithmOptions ()
	By default, maxIter and maxSims are set to boost::none (no restriction). More...
virtual	~AlgorithmOptions ()
AlgorithmOptions	clone () const
Getters
boost::optional< int >	maxIter () const
boost::optional< int >	maxSims () const
std::vector< Attribute >	options () const
	Getter provided for serialization; not for general use. More...
Setters
void	setMaxIter (int maxIter)
void	setMaxSims (int maxSims)
void	clearMaxIter ()
void	clearMaxSims ()
Type Casting
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...

Protected Member Functions
void	setAlgorithm (const Algorithm &algorithm)
QVariant	toVariant () const

Related Functions
(Note that these are not member functions.)
typedef std::vector < AlgorithmOptions >	AlgorithmOptionsVector
typedef boost::optional < AlgorithmOptions >	OptionalAlgorithmOptions

Detailed Description

AlgorithmOptions defines the basic options that all Algorithms are assumed to have, that is, a maximum number of iterations and a maximum number of simulations.

All Algorithm classes are constructed with an AlgorithmOptions object (often of a derived type).

Constructor & Destructor Documentation

openstudio::analysis::AlgorithmOptions::AlgorithmOptions

(

)

By default, maxIter and maxSims are set to boost::none (no restriction).

virtual openstudio::analysis::AlgorithmOptions::~AlgorithmOptions ( )

inlinevirtual

Member Function Documentation

template<typename T >

T openstudio::analysis::AlgorithmOptions::cast ( ) const

inline

Cast to type T.

Throws std::bad_cast if object is not a T.

void openstudio::analysis::AlgorithmOptions::clearMaxIter

(

)

void openstudio::analysis::AlgorithmOptions::clearMaxSims

(

)

AlgorithmOptions openstudio::analysis::AlgorithmOptions::clone

(

)

const

boost::optional<int> openstudio::analysis::AlgorithmOptions::maxIter

(

)

const

boost::optional<int> openstudio::analysis::AlgorithmOptions::maxSims

(

)

const

template<typename T >

boost::optional<T> openstudio::analysis::AlgorithmOptions::optionalCast ( ) const

inline

Cast to boost::optional<T>.

Return value is boost::none (evaluates to false) if object is not a T.

std::vector<Attribute> openstudio::analysis::AlgorithmOptions::options

(

)

const

Getter provided for serialization; not for general use.

void openstudio::analysis::AlgorithmOptions::setAlgorithm ( const Algorithm &  algorithm )

protected

void openstudio::analysis::AlgorithmOptions::setMaxIter

(

int

maxIter

)

void openstudio::analysis::AlgorithmOptions::setMaxSims

(

int

maxSims

)

QVariant openstudio::analysis::AlgorithmOptions::toVariant ( ) const

protected

Friends And Related Function Documentation

typedef std::vector<AlgorithmOptions> AlgorithmOptionsVector

related

typedef boost::optional<AlgorithmOptions> OptionalAlgorithmOptions

related