OpenStudioCore:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "CurveBiquadratic.hpp"

Inheritance diagram for openstudio::model::CurveBiquadratic:

Public Member Functions

 CurveBiquadratic (const Model &model)
virtual ~CurveBiquadratic ()
double coefficient1Constant () const
double coefficient2x () const
double coefficient3xPOW2 () const
double coefficient4y () const
double coefficient5yPOW2 () const
double coefficient6xTIMESY () const
double minimumValueofx () const
double maximumValueofx () const
double minimumValueofy () const
double maximumValueofy () const
boost::optional< double > minimumCurveOutput () const
boost::optional< double > maximumCurveOutput () const
std::string inputUnitTypeforX () const
bool isInputUnitTypeforXDefaulted () const
std::string inputUnitTypeforY () const
bool isInputUnitTypeforYDefaulted () const
std::string outputUnitType () const
bool isOutputUnitTypeDefaulted () const
void setCoefficient1Constant (double coefficient1Constant)
void setCoefficient2x (double coefficient2x)
void setCoefficient3xPOW2 (double coefficient3xPOW2)
void setCoefficient4y (double coefficient4y)
void setCoefficient5yPOW2 (double coefficient5yPOW2)
void setCoefficient6xTIMESY (double coefficient6xTIMESY)
void setMinimumValueofx (double minimumValueofx)
void setMaximumValueofx (double maximumValueofx)
void setMinimumValueofy (double minimumValueofy)
void setMaximumValueofy (double maximumValueofy)
void setMinimumCurveOutput (double minimumCurveOutput)
void resetMinimumCurveOutput ()
void setMaximumCurveOutput (double maximumCurveOutput)
void resetMaximumCurveOutput ()
bool setInputUnitTypeforX (std::string inputUnitTypeforX)
void resetInputUnitTypeforX ()
bool setInputUnitTypeforY (std::string inputUnitTypeforY)
void resetInputUnitTypeforY ()
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 > validInputUnitTypeforYValues ()
static std::vector< std::string > validOutputUnitTypeValues ()

Related Functions

typedef std::vector
< CurveBiquadratic
CurveBiquadraticVector
typedef boost::optional
< CurveBiquadratic
OptionalCurveBiquadratic

Detailed Description

CurveBiquadratic is a Curve that wraps the OpenStudio IDD object 'OS:Curve:Biquadratic'.

The functional form is f(x) = c_1 + c_2 \cdot x + c_3 \cdot x^2 + c_4 \cdot y + c_5 \cdot y^2 + c_6 \cdot x \cdot y

Constructor & Destructor Documentation

openstudio::model::CurveBiquadratic::CurveBiquadratic ( const Model model)
explicit

Initializes all coefficients to 0.0, and sets the bounds on x and y to [0.0,1.0].

virtual openstudio::model::CurveBiquadratic::~CurveBiquadratic ( )
inlinevirtual

Member Function Documentation

double openstudio::model::CurveBiquadratic::coefficient1Constant ( ) const
double openstudio::model::CurveBiquadratic::coefficient2x ( ) const
double openstudio::model::CurveBiquadratic::coefficient3xPOW2 ( ) const
double openstudio::model::CurveBiquadratic::coefficient4y ( ) const
double openstudio::model::CurveBiquadratic::coefficient5yPOW2 ( ) const
double openstudio::model::CurveBiquadratic::coefficient6xTIMESY ( ) const
static IddObjectType openstudio::model::CurveBiquadratic::iddObjectType ( )
static
std::string openstudio::model::CurveBiquadratic::inputUnitTypeforX ( ) const
std::string openstudio::model::CurveBiquadratic::inputUnitTypeforY ( ) const
bool openstudio::model::CurveBiquadratic::isInputUnitTypeforXDefaulted ( ) const
bool openstudio::model::CurveBiquadratic::isInputUnitTypeforYDefaulted ( ) const
bool openstudio::model::CurveBiquadratic::isOutputUnitTypeDefaulted ( ) const
boost::optional<double> openstudio::model::CurveBiquadratic::maximumCurveOutput ( ) const
double openstudio::model::CurveBiquadratic::maximumValueofx ( ) const
double openstudio::model::CurveBiquadratic::maximumValueofy ( ) const
boost::optional<double> openstudio::model::CurveBiquadratic::minimumCurveOutput ( ) const
double openstudio::model::CurveBiquadratic::minimumValueofx ( ) const
double openstudio::model::CurveBiquadratic::minimumValueofy ( ) const
std::string openstudio::model::CurveBiquadratic::outputUnitType ( ) const
void openstudio::model::CurveBiquadratic::resetInputUnitTypeforX ( )
void openstudio::model::CurveBiquadratic::resetInputUnitTypeforY ( )
void openstudio::model::CurveBiquadratic::resetMaximumCurveOutput ( )
void openstudio::model::CurveBiquadratic::resetMinimumCurveOutput ( )
void openstudio::model::CurveBiquadratic::resetOutputUnitType ( )
void openstudio::model::CurveBiquadratic::setCoefficient1Constant ( double  coefficient1Constant)
void openstudio::model::CurveBiquadratic::setCoefficient2x ( double  coefficient2x)
void openstudio::model::CurveBiquadratic::setCoefficient3xPOW2 ( double  coefficient3xPOW2)
void openstudio::model::CurveBiquadratic::setCoefficient4y ( double  coefficient4y)
void openstudio::model::CurveBiquadratic::setCoefficient5yPOW2 ( double  coefficient5yPOW2)
void openstudio::model::CurveBiquadratic::setCoefficient6xTIMESY ( double  coefficient6xTIMESY)
bool openstudio::model::CurveBiquadratic::setInputUnitTypeforX ( std::string  inputUnitTypeforX)
bool openstudio::model::CurveBiquadratic::setInputUnitTypeforY ( std::string  inputUnitTypeforY)
void openstudio::model::CurveBiquadratic::setMaximumCurveOutput ( double  maximumCurveOutput)
void openstudio::model::CurveBiquadratic::setMaximumValueofx ( double  maximumValueofx)
void openstudio::model::CurveBiquadratic::setMaximumValueofy ( double  maximumValueofy)
void openstudio::model::CurveBiquadratic::setMinimumCurveOutput ( double  minimumCurveOutput)
void openstudio::model::CurveBiquadratic::setMinimumValueofx ( double  minimumValueofx)
void openstudio::model::CurveBiquadratic::setMinimumValueofy ( double  minimumValueofy)
bool openstudio::model::CurveBiquadratic::setOutputUnitType ( std::string  outputUnitType)
static std::vector<std::string> openstudio::model::CurveBiquadratic::validInputUnitTypeforXValues ( )
static
static std::vector<std::string> openstudio::model::CurveBiquadratic::validInputUnitTypeforYValues ( )
static
static std::vector<std::string> openstudio::model::CurveBiquadratic::validOutputUnitTypeValues ( )
static

Friends And Related Function Documentation

typedef std::vector<CurveBiquadratic> CurveBiquadraticVector
related
typedef boost::optional<CurveBiquadratic> OptionalCurveBiquadratic
related