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

#include <ZoneHVACWaterToAirHeatPump.hpp>

+ Inheritance diagram for openstudio::model::ZoneHVACWaterToAirHeatPump:

Public Member Functions

Constructors and Destructors
 ZoneHVACWaterToAirHeatPump (const Model &model, Schedule &availabilitySchedule, HVACComponent &supplyAirFan, HVACComponent &heatingCoil, HVACComponent &coolingCoil, HVACComponent &supplementalHeatingCoil)
 
virtual ~ZoneHVACWaterToAirHeatPump ()=default
 
 ZoneHVACWaterToAirHeatPump (const ZoneHVACWaterToAirHeatPump &other)=default
 
 ZoneHVACWaterToAirHeatPump (ZoneHVACWaterToAirHeatPump &&other)=default
 
ZoneHVACWaterToAirHeatPumpoperator= (const ZoneHVACWaterToAirHeatPump &)=default
 
ZoneHVACWaterToAirHeatPumpoperator= (ZoneHVACWaterToAirHeatPump &&)=default
 
Getters
Schedule availabilitySchedule () const
 
boost::optional< double > supplyAirFlowRateDuringCoolingOperation () const
 In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate". More...
 
bool isSupplyAirFlowRateDuringCoolingOperationAutosized () const
 
boost::optional< double > supplyAirFlowRateDuringHeatingOperation () const
 In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate". More...
 
bool isSupplyAirFlowRateDuringHeatingOperationAutosized () const
 
boost::optional< double > supplyAirFlowRateWhenNoCoolingorHeatingisNeeded () const
 In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate". More...
 
bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized () const
 
bool noLoadSupplyAirFlowRateControlSetToLowSpeed () const
 
boost::optional< double > outdoorAirFlowRateDuringCoolingOperation () const
 In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate". More...
 
bool isOutdoorAirFlowRateDuringCoolingOperationAutosized () const
 
boost::optional< double > outdoorAirFlowRateDuringHeatingOperation () const
 In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate". More...
 
bool isOutdoorAirFlowRateDuringHeatingOperationAutosized () const
 
boost::optional< double > outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded () const
 In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate". More...
 
bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized () const
 
HVACComponent supplyAirFan () const
 
HVACComponent heatingCoil () const
 
HVACComponent coolingCoil () const
 
OS_DEPRECATED double maximumCyclingRate () const
 
OS_DEPRECATED bool isMaximumCyclingRateDefaulted () const
 
OS_DEPRECATED double heatPumpTimeConstant () const
 
OS_DEPRECATED bool isHeatPumpTimeConstantDefaulted () const
 
OS_DEPRECATED double fractionofOnCyclePowerUse () const
 
OS_DEPRECATED bool isFractionofOnCyclePowerUseDefaulted () const
 
OS_DEPRECATED double heatPumpFanDelayTime () const
 
OS_DEPRECATED bool isHeatPumpFanDelayTimeDefaulted () const
 
HVACComponent supplementalHeatingCoil () const
 
boost::optional< double > maximumSupplyAirTemperaturefromSupplementalHeater () const
 
bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized () const
 
double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation () const
 
bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted () const
 
std::string fanPlacement () const
 
bool isFanPlacementDefaulted () const
 
std::string heatPumpCoilWaterFlowMode () const
 
bool isHeatPumpCoilWaterFlowModeDefaulted () const
 
boost::optional< SchedulesupplyAirFanOperatingModeSchedule () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
bool setSupplyAirFlowRateDuringCoolingOperation (boost::optional< double > supplyAirFlowRateDuringCoolingOperation)
 
bool setSupplyAirFlowRateDuringCoolingOperation (double supplyAirFlowRateDuringCoolingOperation)
 
void resetSupplyAirFlowRateDuringCoolingOperation ()
 
void autosizeSupplyAirFlowRateDuringCoolingOperation ()
 
bool setSupplyAirFlowRateDuringHeatingOperation (boost::optional< double > supplyAirFlowRateDuringHeatingOperation)
 
bool setSupplyAirFlowRateDuringHeatingOperation (double supplyAirFlowRateDuringHeatingOperation)
 
void resetSupplyAirFlowRateDuringHeatingOperation ()
 
void autosizeSupplyAirFlowRateDuringHeatingOperation ()
 
bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded (boost::optional< double > supplyAirFlowRateWhenNoCoolingorHeatingisNeeded)
 
bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded (double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded)
 
void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ()
 
void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ()
 
bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed (bool noLoadSupplyAirFlowRateControlSetToLowSpeed)
 
bool setOutdoorAirFlowRateDuringCoolingOperation (boost::optional< double > outdoorAirFlowRateDuringCoolingOperation)
 
bool setOutdoorAirFlowRateDuringCoolingOperation (double outdoorAirFlowRateDuringCoolingOperation)
 
void resetOutdoorAirFlowRateDuringCoolingOperation ()
 
void autosizeOutdoorAirFlowRateDuringCoolingOperation ()
 
bool setOutdoorAirFlowRateDuringHeatingOperation (boost::optional< double > outdoorAirFlowRateDuringHeatingOperation)
 
bool setOutdoorAirFlowRateDuringHeatingOperation (double outdoorAirFlowRateDuringHeatingOperation)
 
void resetOutdoorAirFlowRateDuringHeatingOperation ()
 
void autosizeOutdoorAirFlowRateDuringHeatingOperation ()
 
bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded (boost::optional< double > outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded)
 
bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded (double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded)
 
void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ()
 
void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ()
 
bool setSupplyAirFan (HVACComponent &fansOnOff)
 
bool setHeatingCoil (HVACComponent &heatingCoils)
 
bool setCoolingCoil (HVACComponent &coolingCoils)
 
OS_DEPRECATED bool setMaximumCyclingRate (boost::optional< double > maximumCyclingRate)
 
OS_DEPRECATED bool setMaximumCyclingRate (double maximumCyclingRate)
 
OS_DEPRECATED void resetMaximumCyclingRate ()
 
OS_DEPRECATED bool setHeatPumpTimeConstant (boost::optional< double > heatPumpTimeConstant)
 
OS_DEPRECATED bool setHeatPumpTimeConstant (double heatPumpTimeConstant)
 
OS_DEPRECATED void resetHeatPumpTimeConstant ()
 
OS_DEPRECATED bool setFractionofOnCyclePowerUse (boost::optional< double > fractionofOnCyclePowerUse)
 
OS_DEPRECATED bool setFractionofOnCyclePowerUse (double fractionofOnCyclePowerUse)
 
OS_DEPRECATED void resetFractionofOnCyclePowerUse ()
 
OS_DEPRECATED bool setHeatPumpFanDelayTime (boost::optional< double > heatPumpFanDelayTime)
 
OS_DEPRECATED bool setHeatPumpFanDelayTime (double heatPumpFanDelayTime)
 
OS_DEPRECATED void resetHeatPumpFanDelayTime ()
 
bool setSupplementalHeatingCoil (HVACComponent &heatingCoilName)
 
bool setMaximumSupplyAirTemperaturefromSupplementalHeater (boost::optional< double > maximumSupplyAirTemperaturefromSupplementalHeater)
 
bool setMaximumSupplyAirTemperaturefromSupplementalHeater (double maximumSupplyAirTemperaturefromSupplementalHeater)
 
void resetMaximumSupplyAirTemperaturefromSupplementalHeater ()
 
void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater ()
 
bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation (boost::optional< double > maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation)
 
bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation (double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation)
 
void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation ()
 
bool setFanPlacement (const std::string &fanPlacement)
 
void resetFanPlacement ()
 
bool setHeatPumpCoilWaterFlowMode (const std::string &heatPumpCoilWaterFlowMode)
 
void resetHeatPumpCoilWaterFlowMode ()
 
bool setSupplyAirFanOperatingModeSchedule (Schedule &schedule)
 
void resetSupplyAirFanOperatingModeSchedule ()
 
Other
boost::optional< double > autosizedSupplyAirFlowRateDuringCoolingOperation () const
 
boost::optional< double > autosizedSupplyAirFlowRateDuringHeatingOperation () const
 
boost::optional< double > autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded () const
 
boost::optional< double > autosizedOutdoorAirFlowRateDuringCoolingOperation () const
 
boost::optional< double > autosizedOutdoorAirFlowRateDuringHeatingOperation () const
 
boost::optional< double > autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded () const
 
boost::optional< double > autosizedMaximumSupplyAirTemperaturefromSupplementalHeater () const
 
- Public Member Functions inherited from openstudio::model::ZoneHVACComponent
bool addToNode (Node &node)
 Adds this ZoneHVACComponent to a node on an AirLoopHVAC object. More...
 
bool addToThermalZone (ThermalZone &thermalZone)
 Adds this ZoneHVACComponent to the thermal zone while managing all node connections automatically. More...
 
boost::optional< ModelObjectairInletModelObject () const
 Provided for backwards compatibility, use inletNode instead. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the AirLoopHVAC attached to this ZoneHVACComponent. More...
 
boost::optional< ModelObjectairOutletModelObject () const
 Provided for backwards compatibility, use outletNode instead. More...
 
boost::optional< NodeinletNode () const
 Returns the optional node connected to the inletPort(). More...
 
unsigned inletPort () const
 Returns the inlet port. More...
 
ZoneHVACComponentoperator= (const ZoneHVACComponent &)=default
 
ZoneHVACComponentoperator= (ZoneHVACComponent &&)=default
 
boost::optional< NodeoutletNode () const
 Returns the optional node connected to the outletPort(). More...
 
unsigned outletPort () const
 Returns the outlet port. More...
 
bool removeFromAirLoopHVAC ()
 If this ZoneHVACComponent is used as a supply component on an AirLoopHVAC system, then this method will detach this ZoneHVACComponent from the AirLoopHVAC system, otherwise this method does nothing. More...
 
void removeFromThermalZone ()
 Detaches this ZoneHVACComponent from the associated ThermalZone. More...
 
void removeReturnPlenum ()
 Remove any return plenum attached to this ZoneHVACComponent. More...
 
boost::optional
< AirLoopHVACReturnPlenum
returnPlenum () const
 
bool setReturnPlenum (const ThermalZone &plenumZone)
 Establish plenumZone as the return plenum for this ZoneHVACComponent. More...
 
virtual boost::optional
< ThermalZone
thermalZone () const
 Returns the optional ThermalZone that this ZoneHVACComponent is attached to. More...
 
 ZoneHVACComponent (const ZoneHVACComponent &other)=default
 
 ZoneHVACComponent (ZoneHVACComponent &&other)=default
 
virtual ~ZoneHVACComponent ()=default
 
- 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...
 
std::vector< AppGFuelTypeappGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
ComponentType componentType () const
 
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...
 
std::vector< FuelTypecoolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelTypeheatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
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...
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
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 ()=default
 
- 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...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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...
 
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...
 
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< IdfObjectremoveAdditionalProperties ()
 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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) 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
 
- 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)
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject ()=default
 
- 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
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) 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
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
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, bool checkNames=false) 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)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (const IdfObject &other)
 
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 (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup ()
 
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=false) const
 
virtual ~IdfObject ()=default
 

Static Public Member Functions

static std::vector< std::string > fanPlacementValues ()
 
static std::vector< std::string > heatPumpCoilWaterFlowModeValues ()
 
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 ()
 

Related Functions

(Note that these are not member functions.)

using OptionalZoneHVACWaterToAirHeatPump = boost::optional< ZoneHVACWaterToAirHeatPump >
 
using ZoneHVACWaterToAirHeatPumpVector = std::vector< ZoneHVACWaterToAirHeatPump >
 

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::ZoneHVACComponent
using ImplType = detail::ZoneHVACComponent_Impl
 
- Protected Types inherited from openstudio::model::HVACComponent
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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::ZoneHVACComponent
virtual std::vector< ModelObjectchildren () const override
 
 ZoneHVACComponent (IddObjectType type, const Model &model)
 
 ZoneHVACComponent (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
 HVACComponent (IddObjectType type, const Model &model)
 
 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

ZoneHVACWaterToAirHeatPump is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:WaterToAirHeatPump'.

Constructor & Destructor Documentation

openstudio::model::ZoneHVACWaterToAirHeatPump::ZoneHVACWaterToAirHeatPump ( const Model model,
Schedule availabilitySchedule,
HVACComponent supplyAirFan,
HVACComponent heatingCoil,
HVACComponent coolingCoil,
HVACComponent supplementalHeatingCoil 
)
virtual openstudio::model::ZoneHVACWaterToAirHeatPump::~ZoneHVACWaterToAirHeatPump ( )
virtualdefault
openstudio::model::ZoneHVACWaterToAirHeatPump::ZoneHVACWaterToAirHeatPump ( const ZoneHVACWaterToAirHeatPump other)
default
openstudio::model::ZoneHVACWaterToAirHeatPump::ZoneHVACWaterToAirHeatPump ( ZoneHVACWaterToAirHeatPump &&  other)
default

Member Function Documentation

boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedMaximumSupplyAirTemperaturefromSupplementalHeater ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedOutdoorAirFlowRateDuringCoolingOperation ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedOutdoorAirFlowRateDuringHeatingOperation ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedSupplyAirFlowRateDuringCoolingOperation ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedSupplyAirFlowRateDuringHeatingOperation ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ( ) const
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeMaximumSupplyAirTemperaturefromSupplementalHeater ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeOutdoorAirFlowRateDuringCoolingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeOutdoorAirFlowRateDuringHeatingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeSupplyAirFlowRateDuringCoolingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeSupplyAirFlowRateDuringHeatingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ( )
Schedule openstudio::model::ZoneHVACWaterToAirHeatPump::availabilitySchedule ( ) const
HVACComponent openstudio::model::ZoneHVACWaterToAirHeatPump::coolingCoil ( ) const
std::string openstudio::model::ZoneHVACWaterToAirHeatPump::fanPlacement ( ) const
static std::vector<std::string> openstudio::model::ZoneHVACWaterToAirHeatPump::fanPlacementValues ( )
static
OS_DEPRECATED double openstudio::model::ZoneHVACWaterToAirHeatPump::fractionofOnCyclePowerUse ( ) const
HVACComponent openstudio::model::ZoneHVACWaterToAirHeatPump::heatingCoil ( ) const
std::string openstudio::model::ZoneHVACWaterToAirHeatPump::heatPumpCoilWaterFlowMode ( ) const
static std::vector<std::string> openstudio::model::ZoneHVACWaterToAirHeatPump::heatPumpCoilWaterFlowModeValues ( )
static
OS_DEPRECATED double openstudio::model::ZoneHVACWaterToAirHeatPump::heatPumpFanDelayTime ( ) const
OS_DEPRECATED double openstudio::model::ZoneHVACWaterToAirHeatPump::heatPumpTimeConstant ( ) const
static IddObjectType openstudio::model::ZoneHVACWaterToAirHeatPump::iddObjectType ( )
static
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isFanPlacementDefaulted ( ) const
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::isFractionofOnCyclePowerUseDefaulted ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isHeatPumpCoilWaterFlowModeDefaulted ( ) const
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::isHeatPumpFanDelayTimeDefaulted ( ) const
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::isHeatPumpTimeConstantDefaulted ( ) const
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::isMaximumCyclingRateDefaulted ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isOutdoorAirFlowRateDuringCoolingOperationAutosized ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isOutdoorAirFlowRateDuringHeatingOperationAutosized ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isSupplyAirFlowRateDuringCoolingOperationAutosized ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isSupplyAirFlowRateDuringHeatingOperationAutosized ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized ( ) const
OS_DEPRECATED double openstudio::model::ZoneHVACWaterToAirHeatPump::maximumCyclingRate ( ) const
double openstudio::model::ZoneHVACWaterToAirHeatPump::maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::maximumSupplyAirTemperaturefromSupplementalHeater ( ) const
bool openstudio::model::ZoneHVACWaterToAirHeatPump::noLoadSupplyAirFlowRateControlSetToLowSpeed ( ) const
ZoneHVACWaterToAirHeatPump& openstudio::model::ZoneHVACWaterToAirHeatPump::operator= ( const ZoneHVACWaterToAirHeatPump )
default
ZoneHVACWaterToAirHeatPump& openstudio::model::ZoneHVACWaterToAirHeatPump::operator= ( ZoneHVACWaterToAirHeatPump &&  )
default
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::outdoorAirFlowRateDuringCoolingOperation ( ) const

In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate".

boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::outdoorAirFlowRateDuringHeatingOperation ( ) const

In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate".

boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ( ) const

In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate".

void openstudio::model::ZoneHVACWaterToAirHeatPump::resetFanPlacement ( )
OS_DEPRECATED void openstudio::model::ZoneHVACWaterToAirHeatPump::resetFractionofOnCyclePowerUse ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetHeatPumpCoilWaterFlowMode ( )
OS_DEPRECATED void openstudio::model::ZoneHVACWaterToAirHeatPump::resetHeatPumpFanDelayTime ( )
OS_DEPRECATED void openstudio::model::ZoneHVACWaterToAirHeatPump::resetHeatPumpTimeConstant ( )
OS_DEPRECATED void openstudio::model::ZoneHVACWaterToAirHeatPump::resetMaximumCyclingRate ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetMaximumSupplyAirTemperaturefromSupplementalHeater ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetOutdoorAirFlowRateDuringCoolingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetOutdoorAirFlowRateDuringHeatingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetSupplyAirFanOperatingModeSchedule ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetSupplyAirFlowRateDuringCoolingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetSupplyAirFlowRateDuringHeatingOperation ( )
void openstudio::model::ZoneHVACWaterToAirHeatPump::resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ( )
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setCoolingCoil ( HVACComponent coolingCoils)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setFanPlacement ( const std::string &  fanPlacement)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setFractionofOnCyclePowerUse ( boost::optional< double >  fractionofOnCyclePowerUse)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setFractionofOnCyclePowerUse ( double  fractionofOnCyclePowerUse)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setHeatingCoil ( HVACComponent heatingCoils)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setHeatPumpCoilWaterFlowMode ( const std::string &  heatPumpCoilWaterFlowMode)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setHeatPumpFanDelayTime ( boost::optional< double >  heatPumpFanDelayTime)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setHeatPumpFanDelayTime ( double  heatPumpFanDelayTime)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setHeatPumpTimeConstant ( boost::optional< double >  heatPumpTimeConstant)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setHeatPumpTimeConstant ( double  heatPumpTimeConstant)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setMaximumCyclingRate ( boost::optional< double >  maximumCyclingRate)
OS_DEPRECATED bool openstudio::model::ZoneHVACWaterToAirHeatPump::setMaximumCyclingRate ( double  maximumCyclingRate)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation ( boost::optional< double >  maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation ( double  maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setMaximumSupplyAirTemperaturefromSupplementalHeater ( boost::optional< double >  maximumSupplyAirTemperaturefromSupplementalHeater)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setMaximumSupplyAirTemperaturefromSupplementalHeater ( double  maximumSupplyAirTemperaturefromSupplementalHeater)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setNoLoadSupplyAirFlowRateControlSetToLowSpeed ( bool  noLoadSupplyAirFlowRateControlSetToLowSpeed)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setOutdoorAirFlowRateDuringCoolingOperation ( boost::optional< double >  outdoorAirFlowRateDuringCoolingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setOutdoorAirFlowRateDuringCoolingOperation ( double  outdoorAirFlowRateDuringCoolingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setOutdoorAirFlowRateDuringHeatingOperation ( boost::optional< double >  outdoorAirFlowRateDuringHeatingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setOutdoorAirFlowRateDuringHeatingOperation ( double  outdoorAirFlowRateDuringHeatingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ( boost::optional< double >  outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded ( double  outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplementalHeatingCoil ( HVACComponent heatingCoilName)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFan ( HVACComponent fansOnOff)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFanOperatingModeSchedule ( Schedule schedule)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFlowRateDuringCoolingOperation ( boost::optional< double >  supplyAirFlowRateDuringCoolingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFlowRateDuringCoolingOperation ( double  supplyAirFlowRateDuringCoolingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFlowRateDuringHeatingOperation ( boost::optional< double >  supplyAirFlowRateDuringHeatingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFlowRateDuringHeatingOperation ( double  supplyAirFlowRateDuringHeatingOperation)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ( boost::optional< double >  supplyAirFlowRateWhenNoCoolingorHeatingisNeeded)
bool openstudio::model::ZoneHVACWaterToAirHeatPump::setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded ( double  supplyAirFlowRateWhenNoCoolingorHeatingisNeeded)
HVACComponent openstudio::model::ZoneHVACWaterToAirHeatPump::supplementalHeatingCoil ( ) const
HVACComponent openstudio::model::ZoneHVACWaterToAirHeatPump::supplyAirFan ( ) const
boost::optional<Schedule> openstudio::model::ZoneHVACWaterToAirHeatPump::supplyAirFanOperatingModeSchedule ( ) const
boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::supplyAirFlowRateDuringCoolingOperation ( ) const

In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate".

boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::supplyAirFlowRateDuringHeatingOperation ( ) const

In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate".

boost::optional<double> openstudio::model::ZoneHVACWaterToAirHeatPump::supplyAirFlowRateWhenNoCoolingorHeatingisNeeded ( ) const

In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate".

Friends And Related Function Documentation