CurveLinear Class Reference

#include "CurveLinear.hpp"

Inheritance diagram for openstudio::model::CurveLinear:

Public Member Functions
	CurveLinear (const Model &model)
virtual	~CurveLinear ()
double	coefficient1Constant () const
double	coefficient2x () 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	setCoefficient2x (double coefficient2x)
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< CurveLinear >	CurveLinearVector
typedef boost::optional < CurveLinear >	OptionalCurveLinear

Detailed Description

CurveLinear is a Curve that wraps the OpenStudio IDD object 'OS:Curve:Linear'.

The functional form is $f(x) = c_1 + c_2 \cdot x$.

Constructor & Destructor Documentation

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

explicit

Sets $c_1 = 0,\ c_2 = 1.0,\ x\ \text{within}\ [0.0,1.0]$.

virtual openstudio::model::CurveLinear::~CurveLinear ( )

inlinevirtual

Member Function Documentation

double openstudio::model::CurveLinear::coefficient1Constant

(

)

const

double openstudio::model::CurveLinear::coefficient2x

(

)

const

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

static

std::string openstudio::model::CurveLinear::inputUnitTypeforX

(

)

const

bool openstudio::model::CurveLinear::isInputUnitTypeforXDefaulted

(

)

const

bool openstudio::model::CurveLinear::isOutputUnitTypeDefaulted

(

)

const

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

(

)

const

double openstudio::model::CurveLinear::maximumValueofx

(

)

const

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

(

)

const

double openstudio::model::CurveLinear::minimumValueofx

(

)

const

std::string openstudio::model::CurveLinear::outputUnitType

(

)

const

void openstudio::model::CurveLinear::resetInputUnitTypeforX

(

)

void openstudio::model::CurveLinear::resetMaximumCurveOutput

(

)

void openstudio::model::CurveLinear::resetMinimumCurveOutput

(

)

void openstudio::model::CurveLinear::resetOutputUnitType

(

)

void openstudio::model::CurveLinear::setCoefficient1Constant

(

double

coefficient1Constant

)

void openstudio::model::CurveLinear::setCoefficient2x

(

double

coefficient2x

)

bool openstudio::model::CurveLinear::setInputUnitTypeforX

(

std::string

inputUnitTypeforX

)

void openstudio::model::CurveLinear::setMaximumCurveOutput

(

double

maximumCurveOutput

)

void openstudio::model::CurveLinear::setMaximumValueofx

(

double

maximumValueofx

)

void openstudio::model::CurveLinear::setMinimumCurveOutput

(

double

minimumCurveOutput

)

void openstudio::model::CurveLinear::setMinimumValueofx

(

double

minimumValueofx

)

bool openstudio::model::CurveLinear::setOutputUnitType

(

std::string

outputUnitType

)

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

static

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

static

Friends And Related Function Documentation

typedef std::vector<CurveLinear> CurveLinearVector

related

typedef boost::optional<CurveLinear> OptionalCurveLinear

related