All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::CurveBiquadratic Class Reference

#include <CurveBiquadratic.hpp>

+ Inheritance diagram for openstudio::model::CurveBiquadratic:

Public Member Functions

Constructors and Destructors
 CurveBiquadratic (const Model &model)
 Initializes all coefficients to 0.0, and sets the bounds on x and y to [0.0,1.0]. More...
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
bool setCoefficient1Constant (double coefficient1Constant)
bool setCoefficient2x (double coefficient2x)
bool setCoefficient3xPOW2 (double coefficient3xPOW2)
bool setCoefficient4y (double coefficient4y)
bool setCoefficient5yPOW2 (double coefficient5yPOW2)
bool setCoefficient6xTIMESY (double coefficient6xTIMESY)
bool setMinimumValueofx (double minimumValueofx)
bool setMaximumValueofx (double maximumValueofx)
bool setMinimumValueofy (double minimumValueofy)
bool setMaximumValueofy (double maximumValueofy)
bool setMinimumCurveOutput (double minimumCurveOutput)
void resetMinimumCurveOutput ()
bool setMaximumCurveOutput (double maximumCurveOutput)
void resetMaximumCurveOutput ()
bool setInputUnitTypeforX (const std::string &inputUnitTypeforX)
void resetInputUnitTypeforX ()
bool setInputUnitTypeforY (const std::string &inputUnitTypeforY)
void resetInputUnitTypeforY ()
bool setOutputUnitType (const std::string &outputUnitType)
void resetOutputUnitType ()
- Public Member Functions inherited from openstudio::model::Curve
virtual ~Curve ()
int numVariables () const
 Returns the number of independent variable values required to evaluate this Curve. More...
double evaluate (const std::vector< double > &x) const
 Returns the value of this Curve at x. More...
double evaluate (double x) const
 Convenience overload that throws if numVariables() != 1. More...
double evaluate (double x, double y) const
 Convenience overload that throws if numVariables() != 2. More...
double evaluate (double x, double y, double z) const
 Convenience overload that throws if numVariables() != 3. More...
double evaluate (double w, double x, double y, double z) const
 Convenience overload that throws if numVariables() != 4. More...
double evaluate (double v, double w, double x, double y, double z) const
 Convenience overload that throws if numVariables() != 5. More...
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
virtual ~ResourceObject ()
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
virtual ~ParentObject ()
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
Component createComponent () const
 Method for creating sharable Model snippets. More...
Model model () const
 Returns the Model that contains this object. More...
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
std::vector< IdfObject > removeLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
bool operator< (const ModelObject &right) const
bool operator== (const ModelObject &other) const
 equality test More...
bool operator!= (const ModelObject &other) const
 inequality test More...
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) const
 Gets the autosized component value from the sql file. More...
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
boost::optional< ModelObjectconnectedObject (unsigned port) const
boost::optional< unsigned > connectedObjectPort (unsigned port) const

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

(Note that these are not member functions.)

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

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)

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)

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

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

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 ( )
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 ( )
bool openstudio::model::CurveBiquadratic::setCoefficient1Constant ( double  coefficient1Constant)
bool openstudio::model::CurveBiquadratic::setCoefficient2x ( double  coefficient2x)
bool openstudio::model::CurveBiquadratic::setCoefficient3xPOW2 ( double  coefficient3xPOW2)
bool openstudio::model::CurveBiquadratic::setCoefficient4y ( double  coefficient4y)
bool openstudio::model::CurveBiquadratic::setCoefficient5yPOW2 ( double  coefficient5yPOW2)
bool openstudio::model::CurveBiquadratic::setCoefficient6xTIMESY ( double  coefficient6xTIMESY)
bool openstudio::model::CurveBiquadratic::setInputUnitTypeforX ( const std::string &  inputUnitTypeforX)
bool openstudio::model::CurveBiquadratic::setInputUnitTypeforY ( const std::string &  inputUnitTypeforY)
bool openstudio::model::CurveBiquadratic::setMaximumCurveOutput ( double  maximumCurveOutput)
bool openstudio::model::CurveBiquadratic::setMaximumValueofx ( double  maximumValueofx)
bool openstudio::model::CurveBiquadratic::setMaximumValueofy ( double  maximumValueofy)
bool openstudio::model::CurveBiquadratic::setMinimumCurveOutput ( double  minimumCurveOutput)
bool openstudio::model::CurveBiquadratic::setMinimumValueofx ( double  minimumValueofx)
bool openstudio::model::CurveBiquadratic::setMinimumValueofy ( double  minimumValueofy)
bool openstudio::model::CurveBiquadratic::setOutputUnitType ( const std::string &  outputUnitType)
static std::vector<std::string> openstudio::model::CurveBiquadratic::validInputUnitTypeforXValues ( )
static std::vector<std::string> openstudio::model::CurveBiquadratic::validInputUnitTypeforYValues ( )
static std::vector<std::string> openstudio::model::CurveBiquadratic::validOutputUnitTypeValues ( )

Friends And Related Function Documentation

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