CurveExponent Class Reference

#include "CurveExponent.hpp"

Inheritance diagram for openstudio::model::CurveExponent:

Public Member Functions
	CurveExponent (const Model &model)
virtual	~CurveExponent ()
double	coefficient1Constant () const
double	coefficient2Constant () const
double	coefficient3Constant () const
double	minimumValueofx () const
double	maximumValueofx () const
boost::optional< double >	minimumCurveOutput () const
boost::optional< double >	maximumCurveOutput () const
std::string	inputUnitTypeforX () const
bool	isInputUnitTypeforXDefaulted () const
std::string	outputUnitType () const
bool	isOutputUnitTypeDefaulted () const
void	setCoefficient1Constant (double coefficient1Constant)
void	setCoefficient2Constant (double coefficient2Constant)
void	setCoefficient3Constant (double coefficient3Constant)
void	setMinimumValueofx (double minimumValueofx)
void	setMaximumValueofx (double maximumValueofx)
void	setMinimumCurveOutput (double minimumCurveOutput)
void	resetMinimumCurveOutput ()
void	setMaximumCurveOutput (double maximumCurveOutput)
void	resetMaximumCurveOutput ()
bool	setInputUnitTypeforX (std::string inputUnitTypeforX)
void	resetInputUnitTypeforX ()
bool	setOutputUnitType (std::string outputUnitType)
void	resetOutputUnitType ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validInputUnitTypeforXValues ()
static std::vector< std::string >	validOutputUnitTypeValues ()

Related Functions
typedef std::vector < CurveExponent >	CurveExponentVector
typedef boost::optional < CurveExponent >	OptionalCurveExponent

Detailed Description

CurveExponent is a Curve that wraps the OpenStudio IDD object 'OS:Curve:Exponent'.

The functional form is $f(x) = c_1 + c_2 \cdot x^{c_3}$

Constructor & Destructor Documentation

openstudio::model::CurveExponent::CurveExponent ( const Model &  model )

explicit

Initializes $c_1 = 0.0,\ c_2 = c_3 = 1.0$.

Sets the range for x to [0.0,1.0].

virtual openstudio::model::CurveExponent::~CurveExponent ( )

inlinevirtual

Member Function Documentation

double openstudio::model::CurveExponent::coefficient1Constant

(

)

const

double openstudio::model::CurveExponent::coefficient2Constant

(

)

const

double openstudio::model::CurveExponent::coefficient3Constant

(

)

const

static IddObjectType openstudio::model::CurveExponent::iddObjectType ( )

static

std::string openstudio::model::CurveExponent::inputUnitTypeforX

(

)

const

bool openstudio::model::CurveExponent::isInputUnitTypeforXDefaulted

(

)

const

bool openstudio::model::CurveExponent::isOutputUnitTypeDefaulted

(

)

const

boost::optional<double> openstudio::model::CurveExponent::maximumCurveOutput

(

)

const

double openstudio::model::CurveExponent::maximumValueofx

(

)

const

boost::optional<double> openstudio::model::CurveExponent::minimumCurveOutput

(

)

const

double openstudio::model::CurveExponent::minimumValueofx

(

)

const

std::string openstudio::model::CurveExponent::outputUnitType

(

)

const

void openstudio::model::CurveExponent::resetInputUnitTypeforX

(

)

void openstudio::model::CurveExponent::resetMaximumCurveOutput

(

)

void openstudio::model::CurveExponent::resetMinimumCurveOutput

(

)

void openstudio::model::CurveExponent::resetOutputUnitType

(

)

void openstudio::model::CurveExponent::setCoefficient1Constant

(

double

coefficient1Constant

)

void openstudio::model::CurveExponent::setCoefficient2Constant

(

double

coefficient2Constant

)

void openstudio::model::CurveExponent::setCoefficient3Constant

(

double

coefficient3Constant

)

bool openstudio::model::CurveExponent::setInputUnitTypeforX

(

std::string

inputUnitTypeforX

)

void openstudio::model::CurveExponent::setMaximumCurveOutput

(

double

maximumCurveOutput

)

void openstudio::model::CurveExponent::setMaximumValueofx

(

double

maximumValueofx

)

void openstudio::model::CurveExponent::setMinimumCurveOutput

(

double

minimumCurveOutput

)

void openstudio::model::CurveExponent::setMinimumValueofx

(

double

minimumValueofx

)

bool openstudio::model::CurveExponent::setOutputUnitType

(

std::string

outputUnitType

)

static std::vector<std::string> openstudio::model::CurveExponent::validInputUnitTypeforXValues ( )

static

static std::vector<std::string> openstudio::model::CurveExponent::validOutputUnitTypeValues ( )

static

Friends And Related Function Documentation

typedef std::vector<CurveExponent> CurveExponentVector

related

typedef boost::optional<CurveExponent> OptionalCurveExponent

related