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

#include <CoilHeatingWater.hpp>

+ Inheritance diagram for openstudio::model::CoilHeatingWater:

Public Member Functions

Constructors and Destructors
 CoilHeatingWater (const Model &model, Schedule &availableSchedule)
 
 CoilHeatingWater (const Model &model)
 
virtual ~CoilHeatingWater ()
 
Getters and Setters
Schedule availabilitySchedule () const
 Returns the schedule referred to by the Availability Schedule Name field. More...
 
Schedule availableSchedule () const
 
bool setAvailabilitySchedule (Schedule &schedule)
 Sets the schedule referred to by the Availability Schedule Name field. More...
 
bool setAvailableSchedule (Schedule &schedule)
 
boost::optional< double > uFactorTimesAreaValue ()
 Returns the value of the UFactorTimesAreaValue field. More...
 
void setUFactorTimesAreaValue (double value)
 Sets the value of the UFactorTimesAreaValue field. More...
 
bool isUFactorTimesAreaValueAutosized ()
 Returns true if the UFactorTimesAreaValue field is set to autosize. More...
 
void autosizeUFactorTimesAreaValue ()
 Sets the UFactorTimesAreaValue field to autosize. More...
 
boost::optional< double > maximumWaterFlowRate ()
 Returns the value of the MaximumWaterFlowRate field. More...
 
void setMaximumWaterFlowRate (double value)
 Sets the value of the MaximumWaterFlowRate field. More...
 
bool isMaximumWaterFlowRateAutosized ()
 Returns true if the MaximumWaterFlowRate field is set to autosize. More...
 
void autosizeMaximumWaterFlowRate ()
 Sets the MaximumWaterFlowRate field to autosize. More...
 
std::string performanceInputMethod ()
 Returns the value of the PerformanceInputMethod field. More...
 
void setPerformanceInputMethod (std::string value)
 Sets the value of the PerformanceInputMethod field. More...
 
boost::optional< double > ratedCapacity ()
 Returns the value of the RatedCapacity field. More...
 
void setRatedCapacity (double value)
 Sets the value of the RatedCapacity field. More...
 
bool isRatedCapacityAutosized ()
 Returns true if the RatedCapacity field is set to autosize. More...
 
void autosizeRatedCapacity ()
 Sets the RatedCapacity field to autosize. More...
 
double ratedInletWaterTemperature ()
 Returns the value of RatedInletWaterTemperature field. More...
 
void setRatedInletWaterTemperature (double value)
 Sets the value of RatedInletWaterTemperature field. More...
 
double ratedInletAirTemperature ()
 Returns the value of RatedInletWaterTemperature field. More...
 
void setRatedInletAirTemperature (double value)
 Sets the value of RatedInletWaterTemperature field. More...
 
double ratedOutletWaterTemperature ()
 Returns the value of RatedOutletWaterTemperature field. More...
 
void setRatedOutletWaterTemperature (double value)
 Sets the value of RatedOutletWaterTemperature field. More...
 
double ratedOutletAirTemperature ()
 Returns the value of RatedOutletAirTemperature field. More...
 
void setRatedOutletAirTemperature (double value)
 Sets the value of RatedOutletAirTemperature field. More...
 
double ratedRatioForAirAndWaterConvection ()
 Returns the value of RatedRatioForAirAndWaterConvection field. More...
 
void setRatedRatioForAirAndWaterConvection (double value)
 Sets the value of RatedRatioForAirAndWaterConvection field. More...
 
boost::optional
< ControllerWaterCoil
controllerWaterCoil ()
 Returns the optional ControllerWaterCoil associated with this coil. More...
 
- Public Member Functions inherited from openstudio::model::WaterToAirComponent
virtual bool addToNode (Node &node)
 
virtual bool addToSplitter (Splitter &splitter)
 
virtual boost::optional
< ModelObject
airInletModelObject ()
 Returns the optional ModelObject connected to the air inlet port. More...
 
virtual unsigned airInletPort ()
 Returns the air inlet port. More...
 
virtual boost::optional
< AirLoopHVAC
airLoopHVAC () const
 
virtual boost::optional
< ModelObject
airOutletModelObject ()
 Returns the optional ModelObject connected to the air outlet port. More...
 
virtual unsigned airOutletPort ()
 Returns the air outlet port. More...
 
virtual ModelObject clone (Model model) const
 
void disconnectAirSide ()
 
void disconnectWaterSide ()
 
virtual boost::optional
< PlantLoop
plantLoop () const
 
virtual std::vector
< openstudio::IdfObject
remove ()
 
bool removeFromAirLoopHVAC ()
 Removes the component from the airLoopHVAC if one is attached. More...
 
bool removeFromPlantLoop ()
 Removes the component from the plantLoop if one is attached. More...
 
virtual boost::optional
< ModelObject
waterInletModelObject ()
 Returns the optional ModelObject connected to the water inlet port. More...
 
virtual unsigned waterInletPort ()
 Returns the water inlet port. More...
 
virtual boost::optional
< ModelObject
waterOutletModelObject ()
 Returns the optional ModelObject connected to the water outlet port. More...
 
virtual unsigned waterOutletPort ()
 Returns the water outlet port. More...
 
virtual ~WaterToAirComponent ()
 
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
 
boost::optional
< StraightComponent
containingStraightComponent () const
 
boost::optional
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()
 
- 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 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 ()
 

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::HVACComponent
typedef detail::HVACComponent_Impl ImplType
 
- 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::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 Returns the optional ModelObject connected to this object's port. More...
 
 HVACComponent (std::shared_ptr< ImplType > impl)
 
- 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

CoilHeatingWater is a WaterToAirComponent that wraps the IDD object named "OS:Coil:Heating:Water".

Polymorphic behavior:

  1. bool addToNode(Node& node);
    • inherited from HVACComponent
    • Adds this coil to node. If the coil is not allowed at the given node returns false. If controllerWaterCoil is associated with this coil, then the controller's sensor node will be set to the air outlet node.

Constructor & Destructor Documentation

openstudio::model::CoilHeatingWater::CoilHeatingWater ( const Model model,
Schedule availableSchedule 
)
openstudio::model::CoilHeatingWater::CoilHeatingWater ( const Model model)
virtual openstudio::model::CoilHeatingWater::~CoilHeatingWater ( )
inlinevirtual

Member Function Documentation

void openstudio::model::CoilHeatingWater::autosizeMaximumWaterFlowRate ( )

Sets the MaximumWaterFlowRate field to autosize.

void openstudio::model::CoilHeatingWater::autosizeRatedCapacity ( )

Sets the RatedCapacity field to autosize.

void openstudio::model::CoilHeatingWater::autosizeUFactorTimesAreaValue ( )

Sets the UFactorTimesAreaValue field to autosize.

Schedule openstudio::model::CoilHeatingWater::availabilitySchedule ( ) const

Returns the schedule referred to by the Availability Schedule Name field.

Schedule openstudio::model::CoilHeatingWater::availableSchedule ( ) const
boost::optional<ControllerWaterCoil> openstudio::model::CoilHeatingWater::controllerWaterCoil ( )

Returns the optional ControllerWaterCoil associated with this coil.

static IddObjectType openstudio::model::CoilHeatingWater::iddObjectType ( )
static
bool openstudio::model::CoilHeatingWater::isMaximumWaterFlowRateAutosized ( )

Returns true if the MaximumWaterFlowRate field is set to autosize.

bool openstudio::model::CoilHeatingWater::isRatedCapacityAutosized ( )

Returns true if the RatedCapacity field is set to autosize.

bool openstudio::model::CoilHeatingWater::isUFactorTimesAreaValueAutosized ( )

Returns true if the UFactorTimesAreaValue field is set to autosize.

boost::optional<double> openstudio::model::CoilHeatingWater::maximumWaterFlowRate ( )

Returns the value of the MaximumWaterFlowRate field.

std::string openstudio::model::CoilHeatingWater::performanceInputMethod ( )

Returns the value of the PerformanceInputMethod field.

boost::optional<double> openstudio::model::CoilHeatingWater::ratedCapacity ( )

Returns the value of the RatedCapacity field.

double openstudio::model::CoilHeatingWater::ratedInletAirTemperature ( )

Returns the value of RatedInletWaterTemperature field.

double openstudio::model::CoilHeatingWater::ratedInletWaterTemperature ( )

Returns the value of RatedInletWaterTemperature field.

double openstudio::model::CoilHeatingWater::ratedOutletAirTemperature ( )

Returns the value of RatedOutletAirTemperature field.

double openstudio::model::CoilHeatingWater::ratedOutletWaterTemperature ( )

Returns the value of RatedOutletWaterTemperature field.

double openstudio::model::CoilHeatingWater::ratedRatioForAirAndWaterConvection ( )

Returns the value of RatedRatioForAirAndWaterConvection field.

bool openstudio::model::CoilHeatingWater::setAvailabilitySchedule ( Schedule schedule)

Sets the schedule referred to by the Availability Schedule Name field.

bool openstudio::model::CoilHeatingWater::setAvailableSchedule ( Schedule schedule)
void openstudio::model::CoilHeatingWater::setMaximumWaterFlowRate ( double  value)

Sets the value of the MaximumWaterFlowRate field.

void openstudio::model::CoilHeatingWater::setPerformanceInputMethod ( std::string  value)

Sets the value of the PerformanceInputMethod field.

Options are UFactorTimesAreaAndDesignWaterFlowRate and NominalCapacity.

void openstudio::model::CoilHeatingWater::setRatedCapacity ( double  value)

Sets the value of the RatedCapacity field.

void openstudio::model::CoilHeatingWater::setRatedInletAirTemperature ( double  value)

Sets the value of RatedInletWaterTemperature field.

void openstudio::model::CoilHeatingWater::setRatedInletWaterTemperature ( double  value)

Sets the value of RatedInletWaterTemperature field.

void openstudio::model::CoilHeatingWater::setRatedOutletAirTemperature ( double  value)

Sets the value of RatedOutletAirTemperature field.

void openstudio::model::CoilHeatingWater::setRatedOutletWaterTemperature ( double  value)

Sets the value of RatedOutletWaterTemperature field.

void openstudio::model::CoilHeatingWater::setRatedRatioForAirAndWaterConvection ( double  value)

Sets the value of RatedRatioForAirAndWaterConvection field.

void openstudio::model::CoilHeatingWater::setUFactorTimesAreaValue ( double  value)

Sets the value of the UFactorTimesAreaValue field.

boost::optional<double> openstudio::model::CoilHeatingWater::uFactorTimesAreaValue ( )

Returns the value of the UFactorTimesAreaValue field.