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

#include <CoilWaterHeatingDesuperheater.hpp>

+ Inheritance diagram for openstudio::model::CoilWaterHeatingDesuperheater:

Public Member Functions

bool addToHeatRejectionTarget (const ModelObject &heatRejectionTarget)
 Sets the heating rejection target from which the desuperheater heating coil rejects energy. More...
 
boost::optional< ModelObjectheatRejectionTarget () const
 
void removeFromHeatRejectionTarget ()
 
Constructors and Destructors
 CoilWaterHeatingDesuperheater (const Model &model, Schedule &setpointTemperatureSchedule)
 
virtual ~CoilWaterHeatingDesuperheater ()=default
 
 CoilWaterHeatingDesuperheater (const CoilWaterHeatingDesuperheater &other)=default
 
 CoilWaterHeatingDesuperheater (CoilWaterHeatingDesuperheater &&other)=default
 
CoilWaterHeatingDesuperheateroperator= (const CoilWaterHeatingDesuperheater &)=default
 
CoilWaterHeatingDesuperheateroperator= (CoilWaterHeatingDesuperheater &&)=default
 
Getters
Schedule availabilitySchedule () const
 
Schedule setpointTemperatureSchedule () const
 
double deadBandTemperatureDifference () const
 
bool isDeadBandTemperatureDifferenceDefaulted () const
 
boost::optional< double > ratedHeatReclaimRecoveryEfficiency () const
 
double ratedInletWaterTemperature () const
 
double ratedOutdoorAirTemperature () const
 
double maximumInletWaterTemperatureforHeatReclaim () const
 
boost::optional< CurveBiquadraticheatReclaimEfficiencyFunctionofTemperatureCurve () const
 
boost::optional< ModelObjectheatingSource () const
 
double waterFlowRate () const
 
double waterPumpPower () const
 
bool isWaterPumpPowerDefaulted () const
 
double fractionofPumpHeattoWater () const
 
bool isFractionofPumpHeattoWaterDefaulted () const
 
double onCycleParasiticElectricLoad () const
 
bool isOnCycleParasiticElectricLoadDefaulted () const
 
double offCycleParasiticElectricLoad () const
 
bool isOffCycleParasiticElectricLoadDefaulted () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
void resetAvailabilitySchedule ()
 
bool setSetpointTemperatureSchedule (Schedule &schedule)
 
bool setDeadBandTemperatureDifference (double deadBandTemperatureDifference)
 
void resetDeadBandTemperatureDifference ()
 
bool setRatedHeatReclaimRecoveryEfficiency (double ratedHeatReclaimRecoveryEfficiency)
 
void resetRatedHeatReclaimRecoveryEfficiency ()
 
bool setRatedInletWaterTemperature (double ratedInletWaterTemperature)
 
bool setRatedOutdoorAirTemperature (double ratedOutdoorAirTemperature)
 
bool setMaximumInletWaterTemperatureforHeatReclaim (double maximumInletWaterTemperatureforHeatReclaim)
 
bool setHeatReclaimEfficiencyFunctionofTemperatureCurve (const CurveBiquadratic &curveBiquadratic)
 
void resetHeatReclaimEfficiencyFunctionofTemperatureCurve ()
 
bool setHeatingSource (const ModelObject &heatingSource)
 Sets the heating source from which the desuperheater heating coil recovers energy. More...
 
void resetHeatingSource ()
 
bool setWaterFlowRate (double waterFlowRate)
 
bool setWaterPumpPower (double waterPumpPower)
 
void resetWaterPumpPower ()
 
bool setFractionofPumpHeattoWater (double fractionofPumpHeattoWater)
 
void resetFractionofPumpHeattoWater ()
 
bool setOnCycleParasiticElectricLoad (double onCycleParasiticElectricLoad)
 
void resetOnCycleParasiticElectricLoad ()
 
bool setOffCycleParasiticElectricLoad (double offCycleParasiticElectricLoad)
 
void resetOffCycleParasiticElectricLoad ()
 
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
 
ModelObject clone (Model model) const
 
void disconnect ()
 
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
 
unsigned inletPort () const
 Returns the inlet port. More...
 
StraightComponentoperator= (const StraightComponent &)=default
 
StraightComponentoperator= (StraightComponent &&)=default
 
boost::optional< ModelObjectoutletModelObject () 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)
 
 StraightComponent (const StraightComponent &other)=default
 
 StraightComponent (StraightComponent &&other)=default
 
virtual ~StraightComponent ()=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< AppGFuelType > appGHeatingFuelTypes () 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< FuelType > coolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelType > heatingFuelTypes () 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< IdfObject > remove ()
 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< 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...
 
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
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

using CoilWaterHeatingDesuperheaterVector = std::vector< CoilWaterHeatingDesuperheater >
 
using OptionalCoilWaterHeatingDesuperheater = boost::optional< CoilWaterHeatingDesuperheater >
 

Additional Inherited Members

- 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 Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () 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)
 

Detailed Description

CoilWaterHeatingDesuperheater is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:WaterHeating:Desuperheater'.

Constructor & Destructor Documentation

openstudio::model::CoilWaterHeatingDesuperheater::CoilWaterHeatingDesuperheater ( const Model model,
Schedule setpointTemperatureSchedule 
)
explicit
virtual openstudio::model::CoilWaterHeatingDesuperheater::~CoilWaterHeatingDesuperheater ( )
virtualdefault
openstudio::model::CoilWaterHeatingDesuperheater::CoilWaterHeatingDesuperheater ( const CoilWaterHeatingDesuperheater other)
default
openstudio::model::CoilWaterHeatingDesuperheater::CoilWaterHeatingDesuperheater ( CoilWaterHeatingDesuperheater &&  other)
default

Member Function Documentation

bool openstudio::model::CoilWaterHeatingDesuperheater::addToHeatRejectionTarget ( const ModelObject heatRejectionTarget)

Sets the heating rejection target from which the desuperheater heating coil rejects energy.

Parameters
[in]heatRejectionTargetThe heating rejection target.

Valid input:
WaterHeaterMixed WaterHeaterStratified

Schedule openstudio::model::CoilWaterHeatingDesuperheater::availabilitySchedule ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::deadBandTemperatureDifference ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::fractionofPumpHeattoWater ( ) const
boost::optional<ModelObject> openstudio::model::CoilWaterHeatingDesuperheater::heatingSource ( ) const
boost::optional<CurveBiquadratic> openstudio::model::CoilWaterHeatingDesuperheater::heatReclaimEfficiencyFunctionofTemperatureCurve ( ) const
boost::optional<ModelObject> openstudio::model::CoilWaterHeatingDesuperheater::heatRejectionTarget ( ) const
static IddObjectType openstudio::model::CoilWaterHeatingDesuperheater::iddObjectType ( )
static
bool openstudio::model::CoilWaterHeatingDesuperheater::isDeadBandTemperatureDifferenceDefaulted ( ) const
bool openstudio::model::CoilWaterHeatingDesuperheater::isFractionofPumpHeattoWaterDefaulted ( ) const
bool openstudio::model::CoilWaterHeatingDesuperheater::isOffCycleParasiticElectricLoadDefaulted ( ) const
bool openstudio::model::CoilWaterHeatingDesuperheater::isOnCycleParasiticElectricLoadDefaulted ( ) const
bool openstudio::model::CoilWaterHeatingDesuperheater::isWaterPumpPowerDefaulted ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::maximumInletWaterTemperatureforHeatReclaim ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::offCycleParasiticElectricLoad ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::onCycleParasiticElectricLoad ( ) const
CoilWaterHeatingDesuperheater& openstudio::model::CoilWaterHeatingDesuperheater::operator= ( const CoilWaterHeatingDesuperheater )
default
CoilWaterHeatingDesuperheater& openstudio::model::CoilWaterHeatingDesuperheater::operator= ( CoilWaterHeatingDesuperheater &&  )
default
boost::optional<double> openstudio::model::CoilWaterHeatingDesuperheater::ratedHeatReclaimRecoveryEfficiency ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::ratedInletWaterTemperature ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::ratedOutdoorAirTemperature ( ) const
void openstudio::model::CoilWaterHeatingDesuperheater::removeFromHeatRejectionTarget ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetAvailabilitySchedule ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetDeadBandTemperatureDifference ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetFractionofPumpHeattoWater ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetHeatingSource ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetHeatReclaimEfficiencyFunctionofTemperatureCurve ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetOffCycleParasiticElectricLoad ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetOnCycleParasiticElectricLoad ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetRatedHeatReclaimRecoveryEfficiency ( )
void openstudio::model::CoilWaterHeatingDesuperheater::resetWaterPumpPower ( )
bool openstudio::model::CoilWaterHeatingDesuperheater::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::CoilWaterHeatingDesuperheater::setDeadBandTemperatureDifference ( double  deadBandTemperatureDifference)
bool openstudio::model::CoilWaterHeatingDesuperheater::setFractionofPumpHeattoWater ( double  fractionofPumpHeattoWater)
bool openstudio::model::CoilWaterHeatingDesuperheater::setHeatingSource ( const ModelObject heatingSource)
bool openstudio::model::CoilWaterHeatingDesuperheater::setHeatReclaimEfficiencyFunctionofTemperatureCurve ( const CurveBiquadratic curveBiquadratic)
bool openstudio::model::CoilWaterHeatingDesuperheater::setMaximumInletWaterTemperatureforHeatReclaim ( double  maximumInletWaterTemperatureforHeatReclaim)
bool openstudio::model::CoilWaterHeatingDesuperheater::setOffCycleParasiticElectricLoad ( double  offCycleParasiticElectricLoad)
bool openstudio::model::CoilWaterHeatingDesuperheater::setOnCycleParasiticElectricLoad ( double  onCycleParasiticElectricLoad)
Schedule openstudio::model::CoilWaterHeatingDesuperheater::setpointTemperatureSchedule ( ) const
bool openstudio::model::CoilWaterHeatingDesuperheater::setRatedHeatReclaimRecoveryEfficiency ( double  ratedHeatReclaimRecoveryEfficiency)
bool openstudio::model::CoilWaterHeatingDesuperheater::setRatedInletWaterTemperature ( double  ratedInletWaterTemperature)
bool openstudio::model::CoilWaterHeatingDesuperheater::setRatedOutdoorAirTemperature ( double  ratedOutdoorAirTemperature)
bool openstudio::model::CoilWaterHeatingDesuperheater::setSetpointTemperatureSchedule ( Schedule schedule)
bool openstudio::model::CoilWaterHeatingDesuperheater::setWaterFlowRate ( double  waterFlowRate)
bool openstudio::model::CoilWaterHeatingDesuperheater::setWaterPumpPower ( double  waterPumpPower)
double openstudio::model::CoilWaterHeatingDesuperheater::waterFlowRate ( ) const
double openstudio::model::CoilWaterHeatingDesuperheater::waterPumpPower ( ) const

Friends And Related Function Documentation