#include <AirLoopHVACUnitaryHeatPumpAirToAir.hpp>
Public Member Functions | |
Constructors and Destructors | |
AirLoopHVACUnitaryHeatPumpAirToAir (const Model &model, Schedule &availabilitySchedule, HVACComponent &supplyFan, HVACComponent &heatingCoil, HVACComponent &coolingCoil, HVACComponent &supplementalHeatingCoil) | |
virtual | ~AirLoopHVACUnitaryHeatPumpAirToAir () |
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 |
boost::optional< ThermalZone > | controllingZone () const |
HVACComponent | supplyAirFan () const |
HVACComponent | heatingCoil () const |
HVACComponent | coolingCoil () 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 |
boost::optional< Schedule > | supplyAirFanOperatingModeSchedule () const |
Returns the supply air fan operating mode schedule, if present. More... | |
std::string | dehumidificationControlType () const |
bool | isDehumidificationControlTypeDefaulted () const |
Setters | |
bool | setAvailabilitySchedule (Schedule &schedule) |
bool | setSupplyAirFlowRateDuringCoolingOperation (double supplyAirFlowRateDuringCoolingOperation) |
void | autosizeSupplyAirFlowRateDuringCoolingOperation () |
bool | setSupplyAirFlowRateDuringHeatingOperation (double n2) |
void | autosizeSupplyAirFlowRateDuringHeatingOperation () |
bool | setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded (double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded) |
void | resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded () |
void | autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded () |
bool | setControllingZone (ThermalZone &zone) |
void | resetControllingZone () |
bool | setSupplyAirFan (HVACComponent &hvacComponent) |
bool | setHeatingCoil (HVACComponent &hvacComponent) |
bool | setCoolingCoil (HVACComponent &hvacComponent) |
bool | setSupplementalHeatingCoil (HVACComponent &hvacComponent) |
bool | setMaximumSupplyAirTemperaturefromSupplementalHeater (double maximumSupplyAirTemperaturefromSupplementalHeater) |
void | autosizeMaximumSupplyAirTemperaturefromSupplementalHeater () |
bool | setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation (double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation) |
void | resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation () |
bool | setFanPlacement (std::string fanPlacement) |
void | resetFanPlacement () |
bool | setSupplyAirFanOperatingModeSchedule (Schedule &schedule) |
void | resetSupplyAirFanOperatingModeSchedule () |
bool | setDehumidificationControlType (std::string dehumidificationControlType) |
void | resetDehumidificationControlType () |
Other | |
boost::optional< double > | autosizedSupplyAirFlowRateDuringCoolingOperation () const |
boost::optional< double > | autosizedSupplyAirFlowRateDuringHeatingOperation () const |
boost::optional< double > | autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded () const |
boost::optional< double > | autosizedMaximumSupplyAirTemperaturefromSupplementalHeater () const |
Public Member Functions inherited from openstudio::model::StraightComponent | |
bool | addToNode (Node &node) |
boost::optional< AirLoopHVAC > | airLoopHVAC () const |
Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More... | |
ModelObject | clone (Model model) const |
void | disconnect () |
boost::optional< ModelObject > | inletModelObject () const |
Returns the optional ModelObject connected to the inlet port. More... | |
unsigned | inletPort () const |
Returns the inlet port. More... | |
boost::optional< ModelObject > | outletModelObject () const |
Returns the optional ModelObject connected to the outlet port. More... | |
unsigned | outletPort () const |
Returns the outlet port. More... | |
std::vector < openstudio::IdfObject > | remove () |
bool | removeFromLoop () |
StraightComponent (IddObjectType type, const Model &model) | |
virtual | ~StraightComponent () |
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< AirLoopHVAC > | airLoopHVAC () 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... | |
void | applySizingValues () |
void | autosize () |
Returns the optional ModelObject connected to this object's port. More... | |
boost::optional< HVACComponent > | containingHVACComponent () 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< Loop > | loop () const |
Returns the optional Loop object that the HVAC component is attached to. More... | |
boost::optional< PlantLoop > | plantLoop () const |
Returns the optional PlantLoop object that the HVAC component is attached to. More... | |
std::vector< IdfObject > | remove () |
Removes the HVACComponent from the model only if isRemovable() return true. More... | |
virtual | ~HVACComponent () |
Public Member Functions inherited from openstudio::model::ParentObject | |
std::vector< IddObjectType > | allowableChildTypes () const |
Returns a vector of allowable children types. More... | |
std::vector< ModelObject > | children () const |
Return direct child objects in the Model. More... | |
virtual | ~ParentObject () |
Public Member Functions inherited from openstudio::model::ModelObject | |
virtual | ~ModelObject () |
ModelObject | clone () const |
Creates a deep copy of this object, placing it in this object's model(). More... | |
ModelObject | clone (Model model) const |
Creates a deep copy of this object, placing it in model. More... | |
Component | createComponent () const |
Method for creating sharable Model snippets. More... | |
Model | model () const |
Returns the Model that contains this object. More... | |
boost::optional< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () const |
Get the resources directly used by this ModelObject. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources () const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
boost::optional< T > | getModelObjectTarget (unsigned index) const |
Get the object of type T pointed to by this object from field index. More... | |
template<typename T > | |
std::vector< T > | getModelObjectTargets () const |
Get all objects of type T to which this object points. More... | |
const std::vector< std::string > & | outputVariableNames () const |
Get all output variables names that could be associated with this object. More... | |
std::vector< OutputVariable > | outputVariables () const |
Get all output variables associated with this object, must run simulation to generate data. More... | |
boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
Get data associated with this output variable and this object. More... | |
std::vector< LifeCycleCost > | lifeCycleCosts () const |
Returns the list of all LifeCycleCosts that refer to this object. More... | |
std::vector< IdfObject > | removeLifeCycleCosts () |
Removes all LifeCycleCosts that refer to this object. More... | |
IddObjectType | iddObjectType () const |
This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
AdditionalProperties | additionalProperties () const |
Returns this object's additional properties, constructing a new object if necessary. More... | |
bool | hasAdditionalProperties () const |
Returns true if this object has additional properties. More... | |
std::vector< IdfObject > | removeAdditionalProperties () |
Removes all additional properties that refer to this object. More... | |
bool | setParent (ParentObject &newParent) |
set the parent, child may have to call non-const methods on the parent More... | |
bool | operator< (const ModelObject &right) const |
bool | operator== (const ModelObject &other) const |
equality test More... | |
bool | operator!= (const ModelObject &other) const |
inequality test More... | |
std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
Gets the autosized component value from the sql file. More... | |
virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
Return the names of the available ems actuators. More... | |
virtual std::vector< std::string > | emsInternalVariableNames () const |
Return the names of the available ems internal variables. More... | |
boost::optional< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
static IddObjectType | iddObjectType () |
static std::vector< std::string > | validDehumidificationControlTypeValues () |
static std::vector< std::string > | validFanPlacementValues () |
Related Functions | |
(Note that these are not member functions.) | |
typedef std::vector < AirLoopHVACUnitaryHeatPumpAirToAir > | AirLoopHVACUnitaryHeatPumpAirToAirVector |
typedef boost::optional < AirLoopHVACUnitaryHeatPumpAirToAir > | OptionalAirLoopHVACUnitaryHeatPumpAirToAir |
Related Functions inherited from openstudio::model::ParentObject | |
std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false) |
Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
typedef std::pair< std::string, std::string > | ScheduleTypeKey |
Typedef for ScheduleTypeRegistry key. More... | |
typedef std::pair< std::string, std::string > | ScheduleTypeKey |
Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
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 Member Functions inherited from openstudio::model::HVACComponent | |
virtual std::vector< ModelObject > | children () const |
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) | |
AirLoopHVACUnitaryHeatPumpAirToAir is a StraightComponent that wraps the OpenStudio IDD object 'OS:AirLoopHVAC:UnitaryHeatPump:AirToAir'.
openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::AirLoopHVACUnitaryHeatPumpAirToAir | ( | const Model & | model, |
Schedule & | availabilitySchedule, | ||
HVACComponent & | supplyFan, | ||
HVACComponent & | heatingCoil, | ||
HVACComponent & | coolingCoil, | ||
HVACComponent & | supplementalHeatingCoil | ||
) |
|
inlinevirtual |
boost::optional<double> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizedMaximumSupplyAirTemperaturefromSupplementalHeater | ( | ) | const |
boost::optional<double> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizedSupplyAirFlowRateDuringCoolingOperation | ( | ) | const |
boost::optional<double> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizedSupplyAirFlowRateDuringHeatingOperation | ( | ) | const |
boost::optional<double> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded | ( | ) | const |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizeMaximumSupplyAirTemperaturefromSupplementalHeater | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizeSupplyAirFlowRateDuringCoolingOperation | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizeSupplyAirFlowRateDuringHeatingOperation | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded | ( | ) |
Schedule openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::availabilitySchedule | ( | ) | const |
boost::optional<ThermalZone> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::controllingZone | ( | ) | const |
HVACComponent openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::coolingCoil | ( | ) | const |
std::string openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::dehumidificationControlType | ( | ) | const |
std::string openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::fanPlacement | ( | ) | const |
HVACComponent openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::heatingCoil | ( | ) | const |
|
static |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isDehumidificationControlTypeDefaulted | ( | ) | const |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isFanPlacementDefaulted | ( | ) | const |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted | ( | ) | const |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized | ( | ) | const |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isSupplyAirFlowRateDuringCoolingOperationAutosized | ( | ) | const |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isSupplyAirFlowRateDuringHeatingOperationAutosized | ( | ) | const |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized | ( | ) | const |
double openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation | ( | ) | const |
boost::optional<double> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::maximumSupplyAirTemperaturefromSupplementalHeater | ( | ) | const |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::resetControllingZone | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::resetDehumidificationControlType | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::resetFanPlacement | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::resetSupplyAirFanOperatingModeSchedule | ( | ) |
void openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded | ( | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setAvailabilitySchedule | ( | Schedule & | schedule | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setControllingZone | ( | ThermalZone & | zone | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setCoolingCoil | ( | HVACComponent & | hvacComponent | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setDehumidificationControlType | ( | std::string | dehumidificationControlType | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setFanPlacement | ( | std::string | fanPlacement | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setHeatingCoil | ( | HVACComponent & | hvacComponent | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation | ( | double | maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setMaximumSupplyAirTemperaturefromSupplementalHeater | ( | double | maximumSupplyAirTemperaturefromSupplementalHeater | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setSupplementalHeatingCoil | ( | HVACComponent & | hvacComponent | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setSupplyAirFan | ( | HVACComponent & | hvacComponent | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setSupplyAirFanOperatingModeSchedule | ( | Schedule & | schedule | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setSupplyAirFlowRateDuringCoolingOperation | ( | double | supplyAirFlowRateDuringCoolingOperation | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setSupplyAirFlowRateDuringHeatingOperation | ( | double | n2 | ) |
bool openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded | ( | double | supplyAirFlowRateWhenNoCoolingorHeatingisNeeded | ) |
HVACComponent openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::supplementalHeatingCoil | ( | ) | const |
HVACComponent openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::supplyAirFan | ( | ) | const |
boost::optional<Schedule> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::supplyAirFanOperatingModeSchedule | ( | ) | const |
Returns the supply air fan operating mode schedule, if present.
In this schedule, values of zero correspond to AUTO fan operation (fan cycles on and off with coils to meet load). Other values indicate that the supply fan is to run continuously.
boost::optional<double> openstudio::model::AirLoopHVACUnitaryHeatPumpAirToAir::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::AirLoopHVACUnitaryHeatPumpAirToAir::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::AirLoopHVACUnitaryHeatPumpAirToAir::supplyAirFlowRateWhenNoCoolingorHeatingisNeeded | ( | ) | const |
In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate".
|
static |
|
static |
|
related |
|
related |