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

#include <CurveRectangularHyperbola2.hpp>

+ Inheritance diagram for openstudio::model::CurveRectangularHyperbola2:

Public Member Functions

Constructors and Destructors
 CurveRectangularHyperbola2 (const Model &model)
 Initializes /f$c_1 = c_2 = c_3 = 1.0,\ xmin = 0.0,\ xmax = 1.0/f$. More...
 
virtual ~CurveRectangularHyperbola2 ()
 
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
void setCoefficient1C1 (double coefficient1C1)
 
void setCoefficient2C2 (double coefficient2C2)
 
void setCoefficient3C3 (double coefficient3C3)
 
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 ()
 
- 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...
 
- 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< IddObjectTypeallowableChildTypes () 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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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...
 
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< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
static std::vector< std::string > validInputUnitTypeforxValues ()
 
static std::vector< std::string > validOutputUnitTypeValues ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< CurveRectangularHyperbola2
CurveRectangularHyperbola2Vector
 
typedef boost::optional
< CurveRectangularHyperbola2
OptionalCurveRectangularHyperbola2
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

CurveRectangularHyperbola2 is a Curve that wraps the OpenStudio IDD object 'OS:Curve:RectangularHyperbola2'.

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

Constructor & Destructor Documentation

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

Initializes /f$c_1 = c_2 = c_3 = 1.0,\ xmin = 0.0,\ xmax = 1.0/f$.

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

Member Function Documentation

double openstudio::model::CurveRectangularHyperbola2::coefficient1C1 ( ) const
double openstudio::model::CurveRectangularHyperbola2::coefficient2C2 ( ) const
double openstudio::model::CurveRectangularHyperbola2::coefficient3C3 ( ) const
static IddObjectType openstudio::model::CurveRectangularHyperbola2::iddObjectType ( )
static
std::string openstudio::model::CurveRectangularHyperbola2::inputUnitTypeforx ( ) const
bool openstudio::model::CurveRectangularHyperbola2::isInputUnitTypeforxDefaulted ( ) const
bool openstudio::model::CurveRectangularHyperbola2::isOutputUnitTypeDefaulted ( ) const
boost::optional<double> openstudio::model::CurveRectangularHyperbola2::maximumCurveOutput ( ) const
double openstudio::model::CurveRectangularHyperbola2::maximumValueofx ( ) const
boost::optional<double> openstudio::model::CurveRectangularHyperbola2::minimumCurveOutput ( ) const
double openstudio::model::CurveRectangularHyperbola2::minimumValueofx ( ) const
std::string openstudio::model::CurveRectangularHyperbola2::outputUnitType ( ) const
void openstudio::model::CurveRectangularHyperbola2::resetInputUnitTypeforx ( )
void openstudio::model::CurveRectangularHyperbola2::resetMaximumCurveOutput ( )
void openstudio::model::CurveRectangularHyperbola2::resetMinimumCurveOutput ( )
void openstudio::model::CurveRectangularHyperbola2::resetOutputUnitType ( )
void openstudio::model::CurveRectangularHyperbola2::setCoefficient1C1 ( double  coefficient1C1)
void openstudio::model::CurveRectangularHyperbola2::setCoefficient2C2 ( double  coefficient2C2)
void openstudio::model::CurveRectangularHyperbola2::setCoefficient3C3 ( double  coefficient3C3)
bool openstudio::model::CurveRectangularHyperbola2::setInputUnitTypeforx ( std::string  inputUnitTypeforx)
void openstudio::model::CurveRectangularHyperbola2::setMaximumCurveOutput ( double  maximumCurveOutput)
void openstudio::model::CurveRectangularHyperbola2::setMaximumValueofx ( double  maximumValueofx)
void openstudio::model::CurveRectangularHyperbola2::setMinimumCurveOutput ( double  minimumCurveOutput)
void openstudio::model::CurveRectangularHyperbola2::setMinimumValueofx ( double  minimumValueofx)
bool openstudio::model::CurveRectangularHyperbola2::setOutputUnitType ( std::string  outputUnitType)
static std::vector<std::string> openstudio::model::CurveRectangularHyperbola2::validInputUnitTypeforxValues ( )
static
static std::vector<std::string> openstudio::model::CurveRectangularHyperbola2::validOutputUnitTypeValues ( )
static

Friends And Related Function Documentation