ContinuousVariable Class Reference

#include "ContinuousVariable.hpp"

Inheritance diagram for openstudio::analysis::ContinuousVariable:

Public Member Functions
virtual	~ContinuousVariable ()
boost::optional< double >	minimum () const
boost::optional< double >	maximum () const
boost::optional< double >	increment () const
boost::optional< int >	nSteps () const
bool	isFeasible (double value) const
std::vector< double >	incrementalValues () const
void	setMinimum (double minimum)
void	setMaximum (double maximum)
void	setIncrement (double increment)
void	setNSteps (int nSteps)
void	clearMinimum ()
void	clearMaximum ()
void	clearIncrement ()
void	clearNSteps ()
boost::optional< double >	truncate (double value) const

Related Functions
typedef std::vector < ContinuousVariable >	ContinuousVariableVector
typedef boost::optional < ContinuousVariable >	OptionalContinuousVariable

Detailed Description

A ContinuousVariable is an InputVariable whose value is a real number, perhaps restricted to lie within some bounds.

Constructor & Destructor Documentation

virtual openstudio::analysis::ContinuousVariable::~ContinuousVariable ( )

inlinevirtual

Member Function Documentation

void openstudio::analysis::ContinuousVariable::clearIncrement

(

)

void openstudio::analysis::ContinuousVariable::clearMaximum

(

)

void openstudio::analysis::ContinuousVariable::clearMinimum

(

)

void openstudio::analysis::ContinuousVariable::clearNSteps

(

)

boost::optional<double> openstudio::analysis::ContinuousVariable::increment

(

)

const

Returns the increment to be applied to this ContinuousVariable when using minimum() and maximum() to create discrete values.

std::vector<double> openstudio::analysis::ContinuousVariable::incrementalValues

(

)

const

Returns a vector of incremental values, if minimum() && maximum() && (increment() || nSteps()).

There are two exceptional cases. If minimum() > maximum(), then an empty vector is returned. If equal(minimum(),maximum()), then a single value is returned.

bool openstudio::analysis::ContinuousVariable::isFeasible

(

double

value

)

const

Returns true if value in [minimum,maximum].

boost::optional<double> openstudio::analysis::ContinuousVariable::maximum

(

)

const

Returns the maximum, or upper bound, on the ContinuousVariable, if it exists.

boost::optional<double> openstudio::analysis::ContinuousVariable::minimum

(

)

const

Returns the minimum, or lower bound, on the ContinuousVariable, if it exists.

boost::optional<int> openstudio::analysis::ContinuousVariable::nSteps

(

)

const

Returns the number of steps to be used with minimum() and maximum() to create discrete values.

void openstudio::analysis::ContinuousVariable::setIncrement

(

double

increment

)

Sets increment and nullifies nSteps.

void openstudio::analysis::ContinuousVariable::setMaximum

(

double

maximum

)

void openstudio::analysis::ContinuousVariable::setMinimum

(

double

minimum

)

void openstudio::analysis::ContinuousVariable::setNSteps

(

int

nSteps

)

Sets nSteps and nullifies increment.

boost::optional<double> openstudio::analysis::ContinuousVariable::truncate

(

double

value

)

const

Truncates value to [minimum,maximum].

If minimum > maximum, returns boost::none.

Friends And Related Function Documentation

typedef std::vector<ContinuousVariable> ContinuousVariableVector

related

typedef boost::optional<ContinuousVariable> OptionalContinuousVariable

related