CurveQuartic Class Reference

#include "CurveQuartic.hpp"

Inheritance diagram for openstudio::model::CurveQuartic:

Public Member Functions
	CurveQuartic (const Model &model)
virtual	~CurveQuartic ()
double	coefficient1Constant () const
double	coefficient2x () const
double	coefficient3xPOW2 () const
double	coefficient4xPOW3 () const
double	coefficient5xPOW4 () 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
bool	setCoefficient1Constant (double coefficient1Constant)
bool	setCoefficient2x (double coefficient2x)
bool	setCoefficient3xPOW2 (double coefficient3xPOW2)
bool	setCoefficient4xPOW3 (double coefficient4xPOW3)
bool	setCoefficient5xPOW4 (double coefficient5xPOW4)
bool	setMinimumValueofx (double minimumValueofx)
bool	setMaximumValueofx (double maximumValueofx)
bool	setMinimumCurveOutput (double minimumCurveOutput)
void	resetMinimumCurveOutput ()
bool	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< CurveQuartic >	CurveQuarticVector
typedef boost::optional < CurveQuartic >	OptionalCurveQuartic

Detailed Description

CurveQuartic is a Curve that wraps the OpenStudio IDD object 'OS:Curve:Quartic'.

The functional form is $f(x) = c_1 + c_2 \cdot x + c_3 \cdot x^2 + c_4 \cdot x^3 + c_5 \cdot x^4$

Constructor & Destructor Documentation

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

explicit

Initializes $c_1 = c_2 = c_3 = c_4 = 0.0,\ c_5 = 1.0,\ x\ \text{in}\ [0.0,1.0]$.

virtual openstudio::model::CurveQuartic::~CurveQuartic ( )

inlinevirtual

Member Function Documentation

double openstudio::model::CurveQuartic::coefficient1Constant

(

)

const

double openstudio::model::CurveQuartic::coefficient2x

(

)

const

double openstudio::model::CurveQuartic::coefficient3xPOW2

(

)

const

double openstudio::model::CurveQuartic::coefficient4xPOW3

(

)

const

double openstudio::model::CurveQuartic::coefficient5xPOW4

(

)

const

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

static

std::string openstudio::model::CurveQuartic::inputUnitTypeforX

(

)

const

bool openstudio::model::CurveQuartic::isInputUnitTypeforXDefaulted

(

)

const

bool openstudio::model::CurveQuartic::isOutputUnitTypeDefaulted

(

)

const

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

(

)

const

double openstudio::model::CurveQuartic::maximumValueofx

(

)

const

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

(

)

const

double openstudio::model::CurveQuartic::minimumValueofx

(

)

const

std::string openstudio::model::CurveQuartic::outputUnitType

(

)

const

void openstudio::model::CurveQuartic::resetInputUnitTypeforX

(

)

void openstudio::model::CurveQuartic::resetMaximumCurveOutput

(

)

void openstudio::model::CurveQuartic::resetMinimumCurveOutput

(

)

void openstudio::model::CurveQuartic::resetOutputUnitType

(

)

bool openstudio::model::CurveQuartic::setCoefficient1Constant

(

double

coefficient1Constant

)

bool openstudio::model::CurveQuartic::setCoefficient2x

(

double

coefficient2x

)

bool openstudio::model::CurveQuartic::setCoefficient3xPOW2

(

double

coefficient3xPOW2

)

bool openstudio::model::CurveQuartic::setCoefficient4xPOW3

(

double

coefficient4xPOW3

)

bool openstudio::model::CurveQuartic::setCoefficient5xPOW4

(

double

coefficient5xPOW4

)

bool openstudio::model::CurveQuartic::setInputUnitTypeforX

(

std::string

inputUnitTypeforX

)

bool openstudio::model::CurveQuartic::setMaximumCurveOutput

(

double

maximumCurveOutput

)

bool openstudio::model::CurveQuartic::setMaximumValueofx

(

double

maximumValueofx

)

bool openstudio::model::CurveQuartic::setMinimumCurveOutput

(

double

minimumCurveOutput

)

bool openstudio::model::CurveQuartic::setMinimumValueofx

(

double

minimumValueofx

)

bool openstudio::model::CurveQuartic::setOutputUnitType

(

std::string

outputUnitType

)

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

static

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

static

Friends And Related Function Documentation

typedef std::vector<CurveQuartic> CurveQuarticVector

related

typedef boost::optional<CurveQuartic> OptionalCurveQuartic

related