openstudio::model::CurveRectangularHyperbola1 Class Reference

#include <CurveRectangularHyperbola1.hpp>

Inheritance diagram for openstudio::model::CurveRectangularHyperbola1:

Public Member Functions
Constructors and Destructors
	CurveRectangularHyperbola1 (const Model &model)
	Initializes \(c_1 = c_2 = 1.0,\ c_3 = 0.0,\ xmin = 0.0,\ xmax = 1.0\). More...
virtual	~CurveRectangularHyperbola1 ()
Getters
double	coefficient1C1 () const
double	coefficient2C2 () const
double	coefficient3C3 () 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
Setters
bool	setCoefficient1C1 (double coefficient1C1)
bool	setCoefficient2C2 (double coefficient2C2)
bool	setCoefficient3C3 (double coefficient3C3)
bool	setMinimumValueofx (double minimumValueofx)
bool	setMaximumValueofx (double maximumValueofx)
bool	setMinimumCurveOutput (double minimumCurveOutput)
void	resetMinimumCurveOutput ()
bool	setMaximumCurveOutput (double maximumCurveOutput)
void	resetMaximumCurveOutput ()
bool	setInputUnitTypeforx (const std::string &inputUnitTypeforx)
void	resetInputUnitTypeforx ()
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< ModelObject >	children () 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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data. More...
boost::optional < openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object. More...
std::vector< LifeCycleCost >	lifeCycleCosts () 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...
boost::optional< std::string >	cadObjectId () const
bool	setCADObjectId (const std::string &cadObjectId)
boost::optional< std::string >	gbXMLId () const
bool	setGBXMLId (const std::string &gbXMLId)
boost::optional< std::string >	displayName () const
bool	setDisplayName (const std::string &displayName)
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< ScheduleTypeKey >	getScheduleTypeKeys (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< ModelObject >	connectedObject (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 >	validOutputUnitTypeValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < CurveRectangularHyperbola1 >	CurveRectangularHyperbola1Vector
typedef boost::optional < CurveRectangularHyperbola1 >	OptionalCurveRectangularHyperbola1
Related Functions inherited from openstudio::model::Curve
typedef std::vector< Curve >	CurveVector
typedef boost::optional< Curve >	OptionalCurve
Related Functions inherited from openstudio::model::ResourceObject
typedef boost::optional < ResourceObject >	OptionalResourceObject
typedef std::vector < ResourceObject >	ResourceObjectVector
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...
Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

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

CurveRectangularHyperbola1 is a Curve that wraps the OpenStudio IDD object 'OS:Curve:RectangularHyperbola1'.

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

Constructor & Destructor Documentation

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

explicit

Initializes \(c_1 = c_2 = 1.0,\ c_3 = 0.0,\ xmin = 0.0,\ xmax = 1.0\).

virtual openstudio::model::CurveRectangularHyperbola1::~CurveRectangularHyperbola1 ( )

inlinevirtual

Member Function Documentation

double openstudio::model::CurveRectangularHyperbola1::coefficient1C1

(

)

const

double openstudio::model::CurveRectangularHyperbola1::coefficient2C2

(

)

const

double openstudio::model::CurveRectangularHyperbola1::coefficient3C3

(

)

const

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

static

std::string openstudio::model::CurveRectangularHyperbola1::inputUnitTypeforx

(

)

const

bool openstudio::model::CurveRectangularHyperbola1::isInputUnitTypeforxDefaulted

(

)

const

bool openstudio::model::CurveRectangularHyperbola1::isOutputUnitTypeDefaulted

(

)

const

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

(

)

const

double openstudio::model::CurveRectangularHyperbola1::maximumValueofx

(

)

const

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

(

)

const

double openstudio::model::CurveRectangularHyperbola1::minimumValueofx

(

)

const

std::string openstudio::model::CurveRectangularHyperbola1::outputUnitType

(

)

const

void openstudio::model::CurveRectangularHyperbola1::resetInputUnitTypeforx

(

)

void openstudio::model::CurveRectangularHyperbola1::resetMaximumCurveOutput

(

)

void openstudio::model::CurveRectangularHyperbola1::resetMinimumCurveOutput

(

)

void openstudio::model::CurveRectangularHyperbola1::resetOutputUnitType

(

)

bool openstudio::model::CurveRectangularHyperbola1::setCoefficient1C1

(

double

coefficient1C1

)

bool openstudio::model::CurveRectangularHyperbola1::setCoefficient2C2

(

double

coefficient2C2

)

bool openstudio::model::CurveRectangularHyperbola1::setCoefficient3C3

(

double

coefficient3C3

)

bool openstudio::model::CurveRectangularHyperbola1::setInputUnitTypeforx

(

const std::string &

inputUnitTypeforx

)

bool openstudio::model::CurveRectangularHyperbola1::setMaximumCurveOutput

(

double

maximumCurveOutput

)

bool openstudio::model::CurveRectangularHyperbola1::setMaximumValueofx

(

double

maximumValueofx

)

bool openstudio::model::CurveRectangularHyperbola1::setMinimumCurveOutput

(

double

minimumCurveOutput

)

bool openstudio::model::CurveRectangularHyperbola1::setMinimumValueofx

(

double

minimumValueofx

)

bool openstudio::model::CurveRectangularHyperbola1::setOutputUnitType

(

const std::string &

outputUnitType

)

static std::vector<std::string> openstudio::model::CurveRectangularHyperbola1::validInputUnitTypeforxValues ( )

static

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

static

Friends And Related Function Documentation

typedef std::vector<CurveRectangularHyperbola1> CurveRectangularHyperbola1Vector

related

typedef boost::optional<CurveRectangularHyperbola1> OptionalCurveRectangularHyperbola1

related