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

#include <WaterHeaterStratified.hpp>

+ Inheritance diagram for openstudio::model::WaterHeaterStratified:

Public Member Functions

Constructors and Destructors
 WaterHeaterStratified (const Model &model)
 
virtual ~WaterHeaterStratified ()=default
 
 WaterHeaterStratified (const WaterHeaterStratified &other)=default
 
 WaterHeaterStratified (WaterHeaterStratified &&other)=default
 
WaterHeaterStratifiedoperator= (const WaterHeaterStratified &)=default
 
WaterHeaterStratifiedoperator= (WaterHeaterStratified &&)=default
 
Getters
std::string endUseSubcategory () const
 
boost::optional< double > tankVolume () const
 
bool isTankVolumeAutosized () const
 
boost::optional< double > tankHeight () const
 
bool isTankHeightAutosized () const
 
std::string tankShape () const
 
boost::optional< double > tankPerimeter () const
 
double maximumTemperatureLimit () const
 
std::string heaterPriorityControl () const
 
Schedule heater1SetpointTemperatureSchedule () const
 
double heater1DeadbandTemperatureDifference () const
 
boost::optional< double > heater1Capacity () const
 
bool isHeater1CapacityAutosized () const
 
double heater1Height () const
 
Schedule heater2SetpointTemperatureSchedule () const
 
double heater2DeadbandTemperatureDifference () const
 
double heater2Capacity () const
 
double heater2Height () const
 
std::string heaterFuelType () const
 
double heaterThermalEfficiency () const
 
double offCycleParasiticFuelConsumptionRate () const
 
std::string offCycleParasiticFuelType () const
 
double offCycleParasiticHeatFractiontoTank () const
 
double offCycleParasiticHeight () const
 
double onCycleParasiticFuelConsumptionRate () const
 
std::string onCycleParasiticFuelType () const
 
double onCycleParasiticHeatFractiontoTank () const
 
double onCycleParasiticHeight () const
 
std::string ambientTemperatureIndicator () const
 
boost::optional< ScheduleambientTemperatureSchedule () const
 
boost::optional< ThermalZoneambientTemperatureThermalZone () const
 
boost::optional< std::string > ambientTemperatureOutdoorAirNodeName () const
 
boost::optional< double > uniformSkinLossCoefficientperUnitAreatoAmbientTemperature () const
 
double skinLossFractiontoZone () const
 
boost::optional< double > offCycleFlueLossCoefficienttoAmbientTemperature () const
 
double offCycleFlueLossFractiontoZone () const
 
boost::optional< double > peakUseFlowRate () const
 
boost::optional< ScheduleuseFlowRateFractionSchedule () const
 
boost::optional< SchedulecoldWaterSupplyTemperatureSchedule () const
 
double useSideEffectiveness () const
 
double useSideInletHeight () const
 
boost::optional< double > useSideOutletHeight () const
 
bool isUseSideOutletHeightAutocalculated () const
 
double sourceSideEffectiveness () const
 
boost::optional< double > sourceSideInletHeight () const
 
bool isSourceSideInletHeightAutocalculated () const
 
double sourceSideOutletHeight () const
 
std::string inletMode () const
 
boost::optional< double > useSideDesignFlowRate () const
 
bool isUseSideDesignFlowRateAutosized () const
 
boost::optional< double > sourceSideDesignFlowRate () const
 
bool isSourceSideDesignFlowRateAutosized () const
 
double indirectWaterHeatingRecoveryTime () const
 
int numberofNodes () const
 
double additionalDestratificationConductivity () const
 
double node1AdditionalLossCoefficient () const
 
double node2AdditionalLossCoefficient () const
 
double node3AdditionalLossCoefficient () const
 
double node4AdditionalLossCoefficient () const
 
double node5AdditionalLossCoefficient () const
 
double node6AdditionalLossCoefficient () const
 
double node7AdditionalLossCoefficient () const
 
double node8AdditionalLossCoefficient () const
 
double node9AdditionalLossCoefficient () const
 
double node10AdditionalLossCoefficient () const
 
double node11AdditionalLossCoefficient () const
 
double node12AdditionalLossCoefficient () const
 
std::string sourceSideFlowControlMode () const
 
boost::optional< ScheduleindirectAlternateSetpointTemperatureSchedule () const
 
Setters
bool setEndUseSubcategory (const std::string &endUseSubcategory)
 
bool setTankVolume (double tankVolume)
 
void autosizeTankVolume ()
 
bool setTankHeight (double tankHeight)
 
void autosizeTankHeight ()
 
bool setTankShape (const std::string &tankShape)
 
bool setTankPerimeter (double tankPerimeter)
 
void resetTankPerimeter ()
 
bool setMaximumTemperatureLimit (double maximumTemperatureLimit)
 
bool setHeaterPriorityControl (const std::string &heaterPriorityControl)
 
bool setHeater1SetpointTemperatureSchedule (Schedule &schedule)
 
bool setHeater1DeadbandTemperatureDifference (double heater1DeadbandTemperatureDifference)
 
bool setHeater1Capacity (double heater1Capacity)
 
void autosizeHeater1Capacity ()
 
bool setHeater1Height (double heater1Height)
 
bool setHeater2SetpointTemperatureSchedule (Schedule &schedule)
 
bool setHeater2DeadbandTemperatureDifference (double heater2DeadbandTemperatureDifference)
 
bool setHeater2Capacity (double heater2Capacity)
 
bool setHeater2Height (double heater2Height)
 
bool setHeaterFuelType (const FuelType &heaterFuelType)
 
bool setHeaterFuelType (const std::string &heaterFuelType)
 
bool setHeaterThermalEfficiency (double heaterThermalEfficiency)
 
bool setOffCycleParasiticFuelConsumptionRate (double offCycleParasiticFuelConsumptionRate)
 
bool setOffCycleParasiticFuelType (const FuelType &offCycleParasiticFuelType)
 
bool setOffCycleParasiticFuelType (const std::string &offCycleParasiticFuelType)
 
bool setOffCycleParasiticHeatFractiontoTank (double offCycleParasiticHeatFractiontoTank)
 
bool setOffCycleParasiticHeight (double offCycleParasiticHeight)
 
bool setOnCycleParasiticFuelConsumptionRate (double onCycleParasiticFuelConsumptionRate)
 
bool setOnCycleParasiticFuelType (const FuelType &onCycleParasiticFuelType)
 
bool setOnCycleParasiticFuelType (const std::string &onCycleParasiticFuelType)
 
bool setOnCycleParasiticHeatFractiontoTank (double onCycleParasiticHeatFractiontoTank)
 
bool setOnCycleParasiticHeight (double onCycleParasiticHeight)
 
bool setAmbientTemperatureIndicator (const std::string &ambientTemperatureIndicator)
 
bool setAmbientTemperatureSchedule (Schedule &schedule)
 
void resetAmbientTemperatureSchedule ()
 
bool setAmbientTemperatureThermalZone (const ThermalZone &thermalZone)
 
void resetAmbientTemperatureThermalZone ()
 
bool setAmbientTemperatureOutdoorAirNodeName (const std::string &ambientTemperatureOutdoorAirNodeName)
 
void resetAmbientTemperatureOutdoorAirNodeName ()
 
bool setUniformSkinLossCoefficientperUnitAreatoAmbientTemperature (double uniformSkinLossCoefficientperUnitAreatoAmbientTemperature)
 
void resetUniformSkinLossCoefficientperUnitAreatoAmbientTemperature ()
 
bool setSkinLossFractiontoZone (double skinLossFractiontoZone)
 
bool setOffCycleFlueLossCoefficienttoAmbientTemperature (double offCycleFlueLossCoefficienttoAmbientTemperature)
 
void resetOffCycleFlueLossCoefficienttoAmbientTemperature ()
 
bool setOffCycleFlueLossFractiontoZone (double offCycleFlueLossFractiontoZone)
 
bool setPeakUseFlowRate (double peakUseFlowRate)
 
void resetPeakUseFlowRate ()
 
bool setUseFlowRateFractionSchedule (Schedule &schedule)
 
void resetUseFlowRateFractionSchedule ()
 
bool setColdWaterSupplyTemperatureSchedule (Schedule &schedule)
 
void resetColdWaterSupplyTemperatureSchedule ()
 
bool setUseSideEffectiveness (double useSideEffectiveness)
 
bool setUseSideInletHeight (double useSideInletHeight)
 
bool setUseSideOutletHeight (double useSideOutletHeight)
 
void autocalculateUseSideOutletHeight ()
 
bool setSourceSideEffectiveness (double sourceSideEffectiveness)
 
bool setSourceSideInletHeight (double sourceSideInletHeight)
 
void autocalculateSourceSideInletHeight ()
 
bool setSourceSideOutletHeight (double sourceSideOutletHeight)
 
bool setInletMode (const std::string &inletMode)
 
bool setUseSideDesignFlowRate (double useSideDesignFlowRate)
 
void autosizeUseSideDesignFlowRate ()
 
bool setSourceSideDesignFlowRate (double sourceSideDesignFlowRate)
 
void autosizeSourceSideDesignFlowRate ()
 
bool setIndirectWaterHeatingRecoveryTime (double indirectWaterHeatingRecoveryTime)
 
bool setNumberofNodes (int numberofNodes)
 
bool setAdditionalDestratificationConductivity (double additionalDestratificationConductivity)
 
bool setNode1AdditionalLossCoefficient (double node1AdditionalLossCoefficient)
 
bool setNode2AdditionalLossCoefficient (double node2AdditionalLossCoefficient)
 
bool setNode3AdditionalLossCoefficient (double node3AdditionalLossCoefficient)
 
bool setNode4AdditionalLossCoefficient (double node4AdditionalLossCoefficient)
 
bool setNode5AdditionalLossCoefficient (double node5AdditionalLossCoefficient)
 
bool setNode6AdditionalLossCoefficient (double node6AdditionalLossCoefficient)
 
bool setNode7AdditionalLossCoefficient (double node7AdditionalLossCoefficient)
 
bool setNode8AdditionalLossCoefficient (double node8AdditionalLossCoefficient)
 
bool setNode9AdditionalLossCoefficient (double node9AdditionalLossCoefficient)
 
bool setNode10AdditionalLossCoefficient (double node10AdditionalLossCoefficient)
 
bool setNode11AdditionalLossCoefficient (double node11AdditionalLossCoefficient)
 
bool setNode12AdditionalLossCoefficient (double node12AdditionalLossCoefficient)
 
bool setSourceSideFlowControlMode (const std::string &sourceSideFlowControlMode)
 
bool setIndirectAlternateSetpointTemperatureSchedule (Schedule &schedule)
 
void resetIndirectAlternateSetpointTemperatureSchedule ()
 
Other
boost::optional< double > autosizedTankVolume () const
 
boost::optional< double > autosizedTankHeight () const
 
boost::optional< double > autosizedHeater1Capacity () const
 
boost::optional< double > autosizedUseSideDesignFlowRate () const
 
boost::optional< double > autosizedSourceSideDesignFlowRate () const
 
WaterHeaterSizing waterHeaterSizing () const
 
bool addToSourceSideNode (Node &node)
 
boost::optional< PlantLoopuseSidePlantLoop () const
 
boost::optional< PlantLoopsourceSidePlantLoop () const
 
bool removeFromSourceSidePlantLoop ()
 
boost::optional< ModelObjectuseSideInletModelObject () const
 
boost::optional< ModelObjectuseSideOutletModelObject () const
 
boost::optional< ModelObjectsourceSideInletModelObject () const
 
boost::optional< ModelObjectsourceSideOutletModelObject () const
 
- Public Member Functions inherited from openstudio::model::WaterToWaterComponent
virtual bool addToNode (Node &node)
 
virtual bool addToTertiaryNode (Node &node)
 Add this WaterToWaterComponent to a tertiaryPlantLoop by making connections to the tertiary inlet and outlet. More...
 
virtual ModelObject clone (Model model) const
 
virtual boost::optional
< ModelObject
demandInletModelObject () const
 Returns the optional ModelObject connected to the demand inlet port. More...
 
virtual unsigned demandInletPort () const
 Returns the demand inlet port. More...
 
virtual boost::optional
< ModelObject
demandOutletModelObject () const
 Returns the optional ModelObject connected to the demand outlet port. More...
 
virtual unsigned demandOutletPort () const
 Returns the demand outlet port. More...
 
void disconnect ()
 
WaterToWaterComponentoperator= (const WaterToWaterComponent &)=default
 
WaterToWaterComponentoperator= (WaterToWaterComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a supply component on. More...
 
virtual std::vector
< openstudio::IdfObject
remove ()
 
bool removeFromPlantLoop ()
 Removes the component from the plantLoop if one is attached. More...
 
bool removeFromSecondaryPlantLoop ()
 Removes the component from the secondaryPlantLoop if one is attached. More...
 
bool removeFromTertiaryPlantLoop ()
 Removes the component from the tertiaryPlantLoop if one is attached. More...
 
boost::optional< PlantLoopsecondaryPlantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a demand component on. More...
 
virtual boost::optional
< ModelObject
supplyInletModelObject () const
 Returns the optional ModelObject connected to the supply inlet port. More...
 
virtual unsigned supplyInletPort () const
 Returns the supply inlet port. More...
 
virtual boost::optional
< ModelObject
supplyOutletModelObject () const
 Returns the optional ModelObject connected to the supply outlet port. More...
 
virtual unsigned supplyOutletPort () const
 Returns the supply outlet port. More...
 
boost::optional< ModelObjecttertiaryInletModelObject () const
 Returns the optional ModelObject connected to the tertiary inlet. More...
 
boost::optional< ModelObjecttertiaryOutletModelObject () const
 Returns the optional ModelObject connected to the tertiary outlet. More...
 
boost::optional< PlantLooptertiaryPlantLoop () const
 Tertiary plant loop applies to a limited number of WaterToWaterComponent types that interact with three plant systems. More...
 
 WaterToWaterComponent (IddObjectType type, const Model &model)
 
 WaterToWaterComponent (const WaterToWaterComponent &other)=default
 
 WaterToWaterComponent (WaterToWaterComponent &&other)=default
 
virtual ~WaterToWaterComponent ()=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 > ambientTemperatureIndicatorValues ()
 
static std::vector< std::string > heaterFuelTypeValues ()
 
static std::vector< std::string > heaterPriorityControlValues ()
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > inletModeValues ()
 
static std::vector< std::string > offCycleParasiticFuelTypeValues ()
 
static std::vector< std::string > onCycleParasiticFuelTypeValues ()
 
static std::vector< std::string > sourceSideFlowControlModeValues ()
 
static std::vector< std::string > tankShapeValues ()
 
- 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 OptionalWaterHeaterStratified = boost::optional< WaterHeaterStratified >
 
using WaterHeaterStratifiedVector = std::vector< WaterHeaterStratified >
 

Additional Inherited Members

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

WaterHeaterStratified is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:WaterHeater:Stratified'.

Constructor & Destructor Documentation

openstudio::model::WaterHeaterStratified::WaterHeaterStratified ( const Model model)
explicit
virtual openstudio::model::WaterHeaterStratified::~WaterHeaterStratified ( )
virtualdefault
openstudio::model::WaterHeaterStratified::WaterHeaterStratified ( const WaterHeaterStratified other)
default
openstudio::model::WaterHeaterStratified::WaterHeaterStratified ( WaterHeaterStratified &&  other)
default

Member Function Documentation

double openstudio::model::WaterHeaterStratified::additionalDestratificationConductivity ( ) const
bool openstudio::model::WaterHeaterStratified::addToSourceSideNode ( Node node)
std::string openstudio::model::WaterHeaterStratified::ambientTemperatureIndicator ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::ambientTemperatureIndicatorValues ( )
static
boost::optional<std::string> openstudio::model::WaterHeaterStratified::ambientTemperatureOutdoorAirNodeName ( ) const
boost::optional<Schedule> openstudio::model::WaterHeaterStratified::ambientTemperatureSchedule ( ) const
boost::optional<ThermalZone> openstudio::model::WaterHeaterStratified::ambientTemperatureThermalZone ( ) const
void openstudio::model::WaterHeaterStratified::autocalculateSourceSideInletHeight ( )
void openstudio::model::WaterHeaterStratified::autocalculateUseSideOutletHeight ( )
boost::optional<double> openstudio::model::WaterHeaterStratified::autosizedHeater1Capacity ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::autosizedSourceSideDesignFlowRate ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::autosizedTankHeight ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::autosizedTankVolume ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::autosizedUseSideDesignFlowRate ( ) const
void openstudio::model::WaterHeaterStratified::autosizeHeater1Capacity ( )
void openstudio::model::WaterHeaterStratified::autosizeSourceSideDesignFlowRate ( )
void openstudio::model::WaterHeaterStratified::autosizeTankHeight ( )
void openstudio::model::WaterHeaterStratified::autosizeTankVolume ( )
void openstudio::model::WaterHeaterStratified::autosizeUseSideDesignFlowRate ( )
boost::optional<Schedule> openstudio::model::WaterHeaterStratified::coldWaterSupplyTemperatureSchedule ( ) const
std::string openstudio::model::WaterHeaterStratified::endUseSubcategory ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::heater1Capacity ( ) const
double openstudio::model::WaterHeaterStratified::heater1DeadbandTemperatureDifference ( ) const
double openstudio::model::WaterHeaterStratified::heater1Height ( ) const
Schedule openstudio::model::WaterHeaterStratified::heater1SetpointTemperatureSchedule ( ) const
double openstudio::model::WaterHeaterStratified::heater2Capacity ( ) const
double openstudio::model::WaterHeaterStratified::heater2DeadbandTemperatureDifference ( ) const
double openstudio::model::WaterHeaterStratified::heater2Height ( ) const
Schedule openstudio::model::WaterHeaterStratified::heater2SetpointTemperatureSchedule ( ) const
std::string openstudio::model::WaterHeaterStratified::heaterFuelType ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::heaterFuelTypeValues ( )
static
std::string openstudio::model::WaterHeaterStratified::heaterPriorityControl ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::heaterPriorityControlValues ( )
static
double openstudio::model::WaterHeaterStratified::heaterThermalEfficiency ( ) const
static IddObjectType openstudio::model::WaterHeaterStratified::iddObjectType ( )
static
boost::optional<Schedule> openstudio::model::WaterHeaterStratified::indirectAlternateSetpointTemperatureSchedule ( ) const
double openstudio::model::WaterHeaterStratified::indirectWaterHeatingRecoveryTime ( ) const
std::string openstudio::model::WaterHeaterStratified::inletMode ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::inletModeValues ( )
static
bool openstudio::model::WaterHeaterStratified::isHeater1CapacityAutosized ( ) const
bool openstudio::model::WaterHeaterStratified::isSourceSideDesignFlowRateAutosized ( ) const
bool openstudio::model::WaterHeaterStratified::isSourceSideInletHeightAutocalculated ( ) const
bool openstudio::model::WaterHeaterStratified::isTankHeightAutosized ( ) const
bool openstudio::model::WaterHeaterStratified::isTankVolumeAutosized ( ) const
bool openstudio::model::WaterHeaterStratified::isUseSideDesignFlowRateAutosized ( ) const
bool openstudio::model::WaterHeaterStratified::isUseSideOutletHeightAutocalculated ( ) const
double openstudio::model::WaterHeaterStratified::maximumTemperatureLimit ( ) const
double openstudio::model::WaterHeaterStratified::node10AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node11AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node12AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node1AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node2AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node3AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node4AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node5AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node6AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node7AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node8AdditionalLossCoefficient ( ) const
double openstudio::model::WaterHeaterStratified::node9AdditionalLossCoefficient ( ) const
int openstudio::model::WaterHeaterStratified::numberofNodes ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::offCycleFlueLossCoefficienttoAmbientTemperature ( ) const
double openstudio::model::WaterHeaterStratified::offCycleFlueLossFractiontoZone ( ) const
double openstudio::model::WaterHeaterStratified::offCycleParasiticFuelConsumptionRate ( ) const
std::string openstudio::model::WaterHeaterStratified::offCycleParasiticFuelType ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::offCycleParasiticFuelTypeValues ( )
static
double openstudio::model::WaterHeaterStratified::offCycleParasiticHeatFractiontoTank ( ) const
double openstudio::model::WaterHeaterStratified::offCycleParasiticHeight ( ) const
double openstudio::model::WaterHeaterStratified::onCycleParasiticFuelConsumptionRate ( ) const
std::string openstudio::model::WaterHeaterStratified::onCycleParasiticFuelType ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::onCycleParasiticFuelTypeValues ( )
static
double openstudio::model::WaterHeaterStratified::onCycleParasiticHeatFractiontoTank ( ) const
double openstudio::model::WaterHeaterStratified::onCycleParasiticHeight ( ) const
WaterHeaterStratified& openstudio::model::WaterHeaterStratified::operator= ( const WaterHeaterStratified )
default
WaterHeaterStratified& openstudio::model::WaterHeaterStratified::operator= ( WaterHeaterStratified &&  )
default
boost::optional<double> openstudio::model::WaterHeaterStratified::peakUseFlowRate ( ) const
bool openstudio::model::WaterHeaterStratified::removeFromSourceSidePlantLoop ( )
void openstudio::model::WaterHeaterStratified::resetAmbientTemperatureOutdoorAirNodeName ( )
void openstudio::model::WaterHeaterStratified::resetAmbientTemperatureSchedule ( )
void openstudio::model::WaterHeaterStratified::resetAmbientTemperatureThermalZone ( )
void openstudio::model::WaterHeaterStratified::resetColdWaterSupplyTemperatureSchedule ( )
void openstudio::model::WaterHeaterStratified::resetIndirectAlternateSetpointTemperatureSchedule ( )
void openstudio::model::WaterHeaterStratified::resetOffCycleFlueLossCoefficienttoAmbientTemperature ( )
void openstudio::model::WaterHeaterStratified::resetPeakUseFlowRate ( )
void openstudio::model::WaterHeaterStratified::resetTankPerimeter ( )
void openstudio::model::WaterHeaterStratified::resetUniformSkinLossCoefficientperUnitAreatoAmbientTemperature ( )
void openstudio::model::WaterHeaterStratified::resetUseFlowRateFractionSchedule ( )
bool openstudio::model::WaterHeaterStratified::setAdditionalDestratificationConductivity ( double  additionalDestratificationConductivity)
bool openstudio::model::WaterHeaterStratified::setAmbientTemperatureIndicator ( const std::string &  ambientTemperatureIndicator)
bool openstudio::model::WaterHeaterStratified::setAmbientTemperatureOutdoorAirNodeName ( const std::string &  ambientTemperatureOutdoorAirNodeName)
bool openstudio::model::WaterHeaterStratified::setAmbientTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterStratified::setAmbientTemperatureThermalZone ( const ThermalZone thermalZone)
bool openstudio::model::WaterHeaterStratified::setColdWaterSupplyTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterStratified::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::WaterHeaterStratified::setHeater1Capacity ( double  heater1Capacity)
bool openstudio::model::WaterHeaterStratified::setHeater1DeadbandTemperatureDifference ( double  heater1DeadbandTemperatureDifference)
bool openstudio::model::WaterHeaterStratified::setHeater1Height ( double  heater1Height)
bool openstudio::model::WaterHeaterStratified::setHeater1SetpointTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterStratified::setHeater2Capacity ( double  heater2Capacity)
bool openstudio::model::WaterHeaterStratified::setHeater2DeadbandTemperatureDifference ( double  heater2DeadbandTemperatureDifference)
bool openstudio::model::WaterHeaterStratified::setHeater2Height ( double  heater2Height)
bool openstudio::model::WaterHeaterStratified::setHeater2SetpointTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterStratified::setHeaterFuelType ( const FuelType heaterFuelType)
bool openstudio::model::WaterHeaterStratified::setHeaterFuelType ( const std::string &  heaterFuelType)
bool openstudio::model::WaterHeaterStratified::setHeaterPriorityControl ( const std::string &  heaterPriorityControl)
bool openstudio::model::WaterHeaterStratified::setHeaterThermalEfficiency ( double  heaterThermalEfficiency)
bool openstudio::model::WaterHeaterStratified::setIndirectAlternateSetpointTemperatureSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterStratified::setIndirectWaterHeatingRecoveryTime ( double  indirectWaterHeatingRecoveryTime)
bool openstudio::model::WaterHeaterStratified::setInletMode ( const std::string &  inletMode)
bool openstudio::model::WaterHeaterStratified::setMaximumTemperatureLimit ( double  maximumTemperatureLimit)
bool openstudio::model::WaterHeaterStratified::setNode10AdditionalLossCoefficient ( double  node10AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode11AdditionalLossCoefficient ( double  node11AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode12AdditionalLossCoefficient ( double  node12AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode1AdditionalLossCoefficient ( double  node1AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode2AdditionalLossCoefficient ( double  node2AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode3AdditionalLossCoefficient ( double  node3AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode4AdditionalLossCoefficient ( double  node4AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode5AdditionalLossCoefficient ( double  node5AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode6AdditionalLossCoefficient ( double  node6AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode7AdditionalLossCoefficient ( double  node7AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode8AdditionalLossCoefficient ( double  node8AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNode9AdditionalLossCoefficient ( double  node9AdditionalLossCoefficient)
bool openstudio::model::WaterHeaterStratified::setNumberofNodes ( int  numberofNodes)
bool openstudio::model::WaterHeaterStratified::setOffCycleFlueLossCoefficienttoAmbientTemperature ( double  offCycleFlueLossCoefficienttoAmbientTemperature)
bool openstudio::model::WaterHeaterStratified::setOffCycleFlueLossFractiontoZone ( double  offCycleFlueLossFractiontoZone)
bool openstudio::model::WaterHeaterStratified::setOffCycleParasiticFuelConsumptionRate ( double  offCycleParasiticFuelConsumptionRate)
bool openstudio::model::WaterHeaterStratified::setOffCycleParasiticFuelType ( const FuelType offCycleParasiticFuelType)
bool openstudio::model::WaterHeaterStratified::setOffCycleParasiticFuelType ( const std::string &  offCycleParasiticFuelType)
bool openstudio::model::WaterHeaterStratified::setOffCycleParasiticHeatFractiontoTank ( double  offCycleParasiticHeatFractiontoTank)
bool openstudio::model::WaterHeaterStratified::setOffCycleParasiticHeight ( double  offCycleParasiticHeight)
bool openstudio::model::WaterHeaterStratified::setOnCycleParasiticFuelConsumptionRate ( double  onCycleParasiticFuelConsumptionRate)
bool openstudio::model::WaterHeaterStratified::setOnCycleParasiticFuelType ( const FuelType onCycleParasiticFuelType)
bool openstudio::model::WaterHeaterStratified::setOnCycleParasiticFuelType ( const std::string &  onCycleParasiticFuelType)
bool openstudio::model::WaterHeaterStratified::setOnCycleParasiticHeatFractiontoTank ( double  onCycleParasiticHeatFractiontoTank)
bool openstudio::model::WaterHeaterStratified::setOnCycleParasiticHeight ( double  onCycleParasiticHeight)
bool openstudio::model::WaterHeaterStratified::setPeakUseFlowRate ( double  peakUseFlowRate)
bool openstudio::model::WaterHeaterStratified::setSkinLossFractiontoZone ( double  skinLossFractiontoZone)
bool openstudio::model::WaterHeaterStratified::setSourceSideDesignFlowRate ( double  sourceSideDesignFlowRate)
bool openstudio::model::WaterHeaterStratified::setSourceSideEffectiveness ( double  sourceSideEffectiveness)
bool openstudio::model::WaterHeaterStratified::setSourceSideFlowControlMode ( const std::string &  sourceSideFlowControlMode)
bool openstudio::model::WaterHeaterStratified::setSourceSideInletHeight ( double  sourceSideInletHeight)
bool openstudio::model::WaterHeaterStratified::setSourceSideOutletHeight ( double  sourceSideOutletHeight)
bool openstudio::model::WaterHeaterStratified::setTankHeight ( double  tankHeight)
bool openstudio::model::WaterHeaterStratified::setTankPerimeter ( double  tankPerimeter)
bool openstudio::model::WaterHeaterStratified::setTankShape ( const std::string &  tankShape)
bool openstudio::model::WaterHeaterStratified::setTankVolume ( double  tankVolume)
bool openstudio::model::WaterHeaterStratified::setUniformSkinLossCoefficientperUnitAreatoAmbientTemperature ( double  uniformSkinLossCoefficientperUnitAreatoAmbientTemperature)
bool openstudio::model::WaterHeaterStratified::setUseFlowRateFractionSchedule ( Schedule schedule)
bool openstudio::model::WaterHeaterStratified::setUseSideDesignFlowRate ( double  useSideDesignFlowRate)
bool openstudio::model::WaterHeaterStratified::setUseSideEffectiveness ( double  useSideEffectiveness)
bool openstudio::model::WaterHeaterStratified::setUseSideInletHeight ( double  useSideInletHeight)
bool openstudio::model::WaterHeaterStratified::setUseSideOutletHeight ( double  useSideOutletHeight)
double openstudio::model::WaterHeaterStratified::skinLossFractiontoZone ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::sourceSideDesignFlowRate ( ) const
double openstudio::model::WaterHeaterStratified::sourceSideEffectiveness ( ) const
std::string openstudio::model::WaterHeaterStratified::sourceSideFlowControlMode ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::sourceSideFlowControlModeValues ( )
static
boost::optional<double> openstudio::model::WaterHeaterStratified::sourceSideInletHeight ( ) const
boost::optional<ModelObject> openstudio::model::WaterHeaterStratified::sourceSideInletModelObject ( ) const
double openstudio::model::WaterHeaterStratified::sourceSideOutletHeight ( ) const
boost::optional<ModelObject> openstudio::model::WaterHeaterStratified::sourceSideOutletModelObject ( ) const
boost::optional<PlantLoop> openstudio::model::WaterHeaterStratified::sourceSidePlantLoop ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::tankHeight ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::tankPerimeter ( ) const
std::string openstudio::model::WaterHeaterStratified::tankShape ( ) const
static std::vector<std::string> openstudio::model::WaterHeaterStratified::tankShapeValues ( )
static
boost::optional<double> openstudio::model::WaterHeaterStratified::tankVolume ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::uniformSkinLossCoefficientperUnitAreatoAmbientTemperature ( ) const
boost::optional<Schedule> openstudio::model::WaterHeaterStratified::useFlowRateFractionSchedule ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::useSideDesignFlowRate ( ) const
double openstudio::model::WaterHeaterStratified::useSideEffectiveness ( ) const
double openstudio::model::WaterHeaterStratified::useSideInletHeight ( ) const
boost::optional<ModelObject> openstudio::model::WaterHeaterStratified::useSideInletModelObject ( ) const
boost::optional<double> openstudio::model::WaterHeaterStratified::useSideOutletHeight ( ) const
boost::optional<ModelObject> openstudio::model::WaterHeaterStratified::useSideOutletModelObject ( ) const
boost::optional<PlantLoop> openstudio::model::WaterHeaterStratified::useSidePlantLoop ( ) const
WaterHeaterSizing openstudio::model::WaterHeaterStratified::waterHeaterSizing ( ) const

Friends And Related Function Documentation

using OptionalWaterHeaterStratified = boost::optional<WaterHeaterStratified>
related
using WaterHeaterStratifiedVector = std::vector<WaterHeaterStratified>
related