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

#include <WaterHeaterHeatPump.hpp>

+ Inheritance diagram for openstudio::model::WaterHeaterHeatPump:

Public Member Functions

Constructors and Destructors
 WaterHeaterHeatPump (const Model &model)
 WaterHeaterHeatPump (const Model &model, const ModelObject &dxCoil, const HVACComponent &tank, const HVACComponent &fan, Schedule &compressorSetpointTemperatureSchedule, Schedule &inletAirMixerSchedule)
virtual ~WaterHeaterHeatPump ()
boost::optional< ScheduleavailabilitySchedule () const
Schedule compressorSetpointTemperatureSchedule () const
double deadBandTemperatureDifference () const
boost::optional< double > condenserWaterFlowRate () const
bool isCondenserWaterFlowRateAutosized () const
boost::optional< double > evaporatorAirFlowRate () const
bool isEvaporatorAirFlowRateAutosized () const
std::string inletAirConfiguration () const
boost::optional< ScheduleinletAirTemperatureSchedule () const
boost::optional< ScheduleinletAirHumiditySchedule () const
HVACComponent tank () const
ModelObject dXCoil () const
double minimumInletAirTemperatureforCompressorOperation () const
std::string compressorLocation () const
boost::optional< SchedulecompressorAmbientTemperatureSchedule () const
HVACComponent fan () const
std::string fanPlacement () const
double onCycleParasiticElectricLoad () const
double offCycleParasiticElectricLoad () const
std::string parasiticHeatRejectionLocation () const
Schedule inletAirMixerSchedule () const
std::string controlSensorLocationInStratifiedTank () const
bool setAvailabilitySchedule (Schedule &schedule)
void resetAvailabilitySchedule ()
bool setCompressorSetpointTemperatureSchedule (Schedule &schedule)
bool setDeadBandTemperatureDifference (double deadBandTemperatureDifference)
bool setCondenserWaterFlowRate (double condenserWaterFlowRate)
void resetCondenserWaterFlowRate ()
void autosizeCondenserWaterFlowRate ()
bool setEvaporatorAirFlowRate (double evaporatorAirFlowRate)
void resetEvaporatorAirFlowRate ()
void autosizeEvaporatorAirFlowRate ()
bool setInletAirConfiguration (std::string inletAirConfiguration)
bool setInletAirTemperatureSchedule (Schedule &schedule)
void resetInletAirTemperatureSchedule ()
bool setInletAirHumiditySchedule (Schedule &schedule)
void resetInletAirHumiditySchedule ()
bool setTank (const HVACComponent &waterHeater)
bool setDXCoil (const ModelObject &coil)
bool setMinimumInletAirTemperatureforCompressorOperation (double minimumInletAirTemperatureforCompressorOperation)
bool setCompressorLocation (std::string compressorLocation)
bool setCompressorAmbientTemperatureSchedule (Schedule &schedule)
void resetCompressorAmbientTemperatureSchedule ()
bool setFan (const HVACComponent &fan)
bool setFanPlacement (std::string fanPlacement)
bool setOnCycleParasiticElectricLoad (double onCycleParasiticElectricLoad)
bool setOffCycleParasiticElectricLoad (double offCycleParasiticElectricLoad)
bool setParasiticHeatRejectionLocation (std::string parasiticHeatRejectionLocation)
bool setInletAirMixerSchedule (Schedule &schedule)
bool setControlSensorLocationInStratifiedTank (std::string controlSensorLocationInStratifiedTank)
- 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< AirLoopHVACairLoopHVAC () const
 Returns the AirLoopHVAC attached to this ZoneHVACComponent. More...
boost::optional< NodeinletNode () const
 Returns the optional node connected to the inletPort(). More...
unsigned inletPort () const
 Returns the inlet port. More...
boost::optional< NodeoutletNode () const
 Returns the optional node connected to the outletPort(). More...
unsigned outletPort () const
 Returns the outlet port. More...
void removeFromThermalZone ()
 Detaches this ZoneHVACComponent from the associated ThermalZone. More...
boost::optional< ThermalZonethermalZone ()
 Returns the optional ThermalZone that this ZoneHVACComponent is attached to. More...
virtual ~ZoneHVACComponent ()
- 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...
< 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...
< StraightComponent
containingStraightComponent () const
< 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...
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
< 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...
< 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)
< 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
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 (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=true) const
virtual ~IdfObject ()

Static Public Member Functions

static std::vector< std::string > compressorLocationValues ()
static std::vector< std::string > controlSensorLocationInStratifiedTankValues ()
static std::vector< std::string > fanPlacementValues ()
static IddObjectType iddObjectType ()
static std::vector< std::string > inletAirConfigurationValues ()
static std::vector< std::string > parasiticHeatRejectionLocationValues ()
- 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 boost::optional
< WaterHeaterHeatPump
typedef std::vector
< WaterHeaterHeatPump

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
typedef std::vector
< WorkspaceObject
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
typedef std::vector< IdfObjectIdfObjectVector
typedef boost::optional
< IdfObject
- Protected Types inherited from openstudio::model::ZoneHVACComponent
- 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
- 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)
 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

WaterHeaterHeatPump is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:WaterHeater:HeatPump'.

Constructor & Destructor Documentation

openstudio::model::WaterHeaterHeatPump::WaterHeaterHeatPump ( const Model model)
openstudio::model::WaterHeaterHeatPump::WaterHeaterHeatPump ( const Model model,
const ModelObject dxCoil,
const HVACComponent tank,
const HVACComponent fan,
Schedule compressorSetpointTemperatureSchedule,
Schedule inletAirMixerSchedule 
virtual openstudio::model::WaterHeaterHeatPump::~WaterHeaterHeatPump ( )

Member Function Documentation

void openstudio::model::WaterHeaterHeatPump::autosizeCondenserWaterFlowRate ( )
void openstudio::model::WaterHeaterHeatPump::autosizeEvaporatorAirFlowRate ( )
boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::availabilitySchedule ( ) const
boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::compressorAmbientTemperatureSchedule ( ) const
std::string openstudio::model::WaterHeaterHeatPump::compressorLocation ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::compressorLocationValues ( )
Schedule openstudio::model::WaterHeaterHeatPump::compressorSetpointTemperatureSchedule ( ) const
boost::optional<double> openstudio::model::WaterHeaterHeatPump::condenserWaterFlowRate ( ) const
std::string openstudio::model::WaterHeaterHeatPump::controlSensorLocationInStratifiedTank ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::controlSensorLocationInStratifiedTankValues ( )
double openstudio::model::WaterHeaterHeatPump::deadBandTemperatureDifference ( ) const
ModelObject openstudio::model::WaterHeaterHeatPump::dXCoil ( ) const
boost::optional<double> openstudio::model::WaterHeaterHeatPump::evaporatorAirFlowRate ( ) const
HVACComponent openstudio::model::WaterHeaterHeatPump::fan ( ) const
std::string openstudio::model::WaterHeaterHeatPump::fanPlacement ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::fanPlacementValues ( )
static IddObjectType openstudio::model::WaterHeaterHeatPump::iddObjectType ( )
std::string openstudio::model::WaterHeaterHeatPump::inletAirConfiguration ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::inletAirConfigurationValues ( )
boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::inletAirHumiditySchedule ( ) const
Schedule openstudio::model::WaterHeaterHeatPump::inletAirMixerSchedule ( ) const
boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::inletAirTemperatureSchedule ( ) const
bool openstudio::model::WaterHeaterHeatPump::isCondenserWaterFlowRateAutosized ( ) const
bool openstudio::model::WaterHeaterHeatPump::isEvaporatorAirFlowRateAutosized ( ) const
double openstudio::model::WaterHeaterHeatPump::minimumInletAirTemperatureforCompressorOperation ( ) const
double openstudio::model::WaterHeaterHeatPump::offCycleParasiticElectricLoad ( ) const
double openstudio::model::WaterHeaterHeatPump::onCycleParasiticElectricLoad ( ) const
std::string openstudio::model::WaterHeaterHeatPump::parasiticHeatRejectionLocation ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::parasiticHeatRejectionLocationValues ( )
void openstudio::model::WaterHeaterHeatPump::resetAvailabilitySchedule ( )
void openstudio::model::WaterHeaterHeatPump::resetCompressorAmbientTemperatureSchedule ( )
void openstudio::model::WaterHeaterHeatPump::resetCondenserWaterFlowRate ( )
void openstudio::model::WaterHeaterHeatPump::resetEvaporatorAirFlowRate ( )
void openstudio::model::WaterHeaterHeatPump::resetInletAirHumiditySchedule ( )
void openstudio::model::WaterHeaterHeatPump::resetInletAirTemperatureSchedule ( )
bool openstudio::model::WaterHeaterHeatPump::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterHeatPump::setCompressorAmbientTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterHeatPump::setCompressorLocation ( std::string  compressorLocation)
bool openstudio::model::WaterHeaterHeatPump::setCompressorSetpointTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterHeatPump::setCondenserWaterFlowRate ( double  condenserWaterFlowRate)
bool openstudio::model::WaterHeaterHeatPump::setControlSensorLocationInStratifiedTank ( std::string  controlSensorLocationInStratifiedTank)
bool openstudio::model::WaterHeaterHeatPump::setDeadBandTemperatureDifference ( double  deadBandTemperatureDifference)
bool openstudio::model::WaterHeaterHeatPump::setDXCoil ( const ModelObject coil)
bool openstudio::model::WaterHeaterHeatPump::setEvaporatorAirFlowRate ( double  evaporatorAirFlowRate)
bool openstudio::model::WaterHeaterHeatPump::setFan ( const HVACComponent fan)
bool openstudio::model::WaterHeaterHeatPump::setFanPlacement ( std::string  fanPlacement)
bool openstudio::model::WaterHeaterHeatPump::setInletAirConfiguration ( std::string  inletAirConfiguration)
bool openstudio::model::WaterHeaterHeatPump::setInletAirHumiditySchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterHeatPump::setInletAirMixerSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterHeatPump::setInletAirTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterHeatPump::setMinimumInletAirTemperatureforCompressorOperation ( double  minimumInletAirTemperatureforCompressorOperation)
bool openstudio::model::WaterHeaterHeatPump::setOffCycleParasiticElectricLoad ( double  offCycleParasiticElectricLoad)
bool openstudio::model::WaterHeaterHeatPump::setOnCycleParasiticElectricLoad ( double  onCycleParasiticElectricLoad)
bool openstudio::model::WaterHeaterHeatPump::setParasiticHeatRejectionLocation ( std::string  parasiticHeatRejectionLocation)
bool openstudio::model::WaterHeaterHeatPump::setTank ( const HVACComponent waterHeater)
HVACComponent openstudio::model::WaterHeaterHeatPump::tank ( ) const

Friends And Related Function Documentation

typedef boost::optional<WaterHeaterHeatPump> OptionalWaterHeaterHeatPump
typedef std::vector<WaterHeaterHeatPump> WaterHeaterHeatPumpVector