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

#include <BoilerHotWater.hpp>

+ Inheritance diagram for openstudio::model::BoilerHotWater:

Public Member Functions

Constructors and Destructors
 BoilerHotWater (const Model &model)
virtual ~BoilerHotWater ()
std::string fuelType () const
boost::optional< double > nominalCapacity () const
bool isNominalCapacityAutosized () const
double nominalThermalEfficiency () const
boost::optional< std::string > efficiencyCurveTemperatureEvaluationVariable () const
boost::optional< CurvenormalizedBoilerEfficiencyCurve () const
boost::optional< double > designWaterOutletTemperature () const
 As of EnergyPlus version 9.0.0 this field is no longer used. More...
boost::optional< double > designWaterFlowRate () const
bool isDesignWaterFlowRateAutosized () const
double minimumPartLoadRatio () const
bool isMinimumPartLoadRatioDefaulted () const
double maximumPartLoadRatio () const
bool isMaximumPartLoadRatioDefaulted () const
double optimumPartLoadRatio () const
bool isOptimumPartLoadRatioDefaulted () const
double waterOutletUpperTemperatureLimit () const
bool isWaterOutletUpperTemperatureLimitDefaulted () const
std::string boilerFlowMode () const
bool isBoilerFlowModeDefaulted () const
boost::optional< double > parasiticElectricLoad () const
double sizingFactor () const
bool isSizingFactorDefaulted () const
std::string endUseSubcategory () const
bool setFuelType (std::string fuelType)
bool setNominalCapacity (double nominalCapacity)
void resetNominalCapacity ()
void autosizeNominalCapacity ()
bool setNominalThermalEfficiency (double nominalThermalEfficiency)
bool setEfficiencyCurveTemperatureEvaluationVariable (std::string efficiencyCurveTemperatureEvaluationVariable)
void resetEfficiencyCurveTemperatureEvaluationVariable ()
bool setNormalizedBoilerEfficiencyCurve (const Curve &normalizedBoilerEfficiencyCurve)
void resetNormalizedBoilerEfficiencyCurve ()
bool setDesignWaterOutletTemperature (double designWaterOutletTemperature)
 As of EnergyPlus version 9.0.0 this field is no longer used. More...
void resetDesignWaterOutletTemperature ()
bool setDesignWaterFlowRate (double designWaterFlowRate)
void resetDesignWaterFlowRate ()
void autosizeDesignWaterFlowRate ()
bool setMinimumPartLoadRatio (double minimumPartLoadRatio)
void resetMinimumPartLoadRatio ()
bool setMaximumPartLoadRatio (double maximumPartLoadRatio)
void resetMaximumPartLoadRatio ()
bool setOptimumPartLoadRatio (double optimumPartLoadRatio)
void resetOptimumPartLoadRatio ()
bool setWaterOutletUpperTemperatureLimit (double waterOutletUpperTemperatureLimit)
void resetWaterOutletUpperTemperatureLimit ()
bool setBoilerFlowMode (std::string boilerFlowMode)
void resetBoilerFlowMode ()
bool setParasiticElectricLoad (double parasiticElectricLoad)
void resetParasiticElectricLoad ()
bool setSizingFactor (double sizingFactor)
void resetSizingFactor ()
boost::optional< double > autosizedNominalCapacity () const
boost::optional< double > autosizedDesignWaterFlowRate () const
bool setEndUseSubcategory (const std::string &endUseSubcategory)
- 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...
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
unsigned outletPort () const
 Returns the outlet port. More...
< 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< 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...
void applySizingValues ()
void autosize ()
 Returns the optional ModelObject connected to this object's port. 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...
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...
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...
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 (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< 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, 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)
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 ()
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
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 ()

Static Public Member Functions

static IddObjectType iddObjectType ()
static std::vector< std::string > validBoilerFlowModeValues ()
static std::vector< std::string > validEfficiencyCurveTemperatureEvaluationVariableValues ()
static std::vector< std::string > validFuelTypeValues ()
- 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 std::vector
< BoilerHotWater
typedef boost::optional
< BoilerHotWater

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::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::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

BoilerHotWater is a StraightComponent that wraps the OpenStudio IDD object 'OS:Boiler:HotWater'.

Constructor & Destructor Documentation

openstudio::model::BoilerHotWater::BoilerHotWater ( const Model model)
virtual openstudio::model::BoilerHotWater::~BoilerHotWater ( )

Member Function Documentation

boost::optional<double> openstudio::model::BoilerHotWater::autosizedDesignWaterFlowRate ( ) const
void openstudio::model::BoilerHotWater::autosizeDesignWaterFlowRate ( )
boost::optional<double> openstudio::model::BoilerHotWater::autosizedNominalCapacity ( ) const
void openstudio::model::BoilerHotWater::autosizeNominalCapacity ( )
std::string openstudio::model::BoilerHotWater::boilerFlowMode ( ) const
boost::optional<double> openstudio::model::BoilerHotWater::designWaterFlowRate ( ) const
boost::optional<double> openstudio::model::BoilerHotWater::designWaterOutletTemperature ( ) const

As of EnergyPlus version 9.0.0 this field is no longer used.

boost::optional<std::string> openstudio::model::BoilerHotWater::efficiencyCurveTemperatureEvaluationVariable ( ) const
std::string openstudio::model::BoilerHotWater::endUseSubcategory ( ) const
std::string openstudio::model::BoilerHotWater::fuelType ( ) const
static IddObjectType openstudio::model::BoilerHotWater::iddObjectType ( )
bool openstudio::model::BoilerHotWater::isBoilerFlowModeDefaulted ( ) const
bool openstudio::model::BoilerHotWater::isDesignWaterFlowRateAutosized ( ) const
bool openstudio::model::BoilerHotWater::isMaximumPartLoadRatioDefaulted ( ) const
bool openstudio::model::BoilerHotWater::isMinimumPartLoadRatioDefaulted ( ) const
bool openstudio::model::BoilerHotWater::isNominalCapacityAutosized ( ) const
bool openstudio::model::BoilerHotWater::isOptimumPartLoadRatioDefaulted ( ) const
bool openstudio::model::BoilerHotWater::isSizingFactorDefaulted ( ) const
bool openstudio::model::BoilerHotWater::isWaterOutletUpperTemperatureLimitDefaulted ( ) const
double openstudio::model::BoilerHotWater::maximumPartLoadRatio ( ) const
double openstudio::model::BoilerHotWater::minimumPartLoadRatio ( ) const
boost::optional<double> openstudio::model::BoilerHotWater::nominalCapacity ( ) const
double openstudio::model::BoilerHotWater::nominalThermalEfficiency ( ) const
boost::optional<Curve> openstudio::model::BoilerHotWater::normalizedBoilerEfficiencyCurve ( ) const
double openstudio::model::BoilerHotWater::optimumPartLoadRatio ( ) const
boost::optional<double> openstudio::model::BoilerHotWater::parasiticElectricLoad ( ) const
void openstudio::model::BoilerHotWater::resetBoilerFlowMode ( )
void openstudio::model::BoilerHotWater::resetDesignWaterFlowRate ( )
void openstudio::model::BoilerHotWater::resetDesignWaterOutletTemperature ( )
void openstudio::model::BoilerHotWater::resetEfficiencyCurveTemperatureEvaluationVariable ( )
void openstudio::model::BoilerHotWater::resetMaximumPartLoadRatio ( )
void openstudio::model::BoilerHotWater::resetMinimumPartLoadRatio ( )
void openstudio::model::BoilerHotWater::resetNominalCapacity ( )
void openstudio::model::BoilerHotWater::resetNormalizedBoilerEfficiencyCurve ( )
void openstudio::model::BoilerHotWater::resetOptimumPartLoadRatio ( )
void openstudio::model::BoilerHotWater::resetParasiticElectricLoad ( )
void openstudio::model::BoilerHotWater::resetSizingFactor ( )
void openstudio::model::BoilerHotWater::resetWaterOutletUpperTemperatureLimit ( )
bool openstudio::model::BoilerHotWater::setBoilerFlowMode ( std::string  boilerFlowMode)
bool openstudio::model::BoilerHotWater::setDesignWaterFlowRate ( double  designWaterFlowRate)
bool openstudio::model::BoilerHotWater::setDesignWaterOutletTemperature ( double  designWaterOutletTemperature)

As of EnergyPlus version 9.0.0 this field is no longer used.

bool openstudio::model::BoilerHotWater::setEfficiencyCurveTemperatureEvaluationVariable ( std::string  efficiencyCurveTemperatureEvaluationVariable)
bool openstudio::model::BoilerHotWater::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::BoilerHotWater::setFuelType ( std::string  fuelType)
bool openstudio::model::BoilerHotWater::setMaximumPartLoadRatio ( double  maximumPartLoadRatio)
bool openstudio::model::BoilerHotWater::setMinimumPartLoadRatio ( double  minimumPartLoadRatio)
bool openstudio::model::BoilerHotWater::setNominalCapacity ( double  nominalCapacity)
bool openstudio::model::BoilerHotWater::setNominalThermalEfficiency ( double  nominalThermalEfficiency)
bool openstudio::model::BoilerHotWater::setNormalizedBoilerEfficiencyCurve ( const Curve normalizedBoilerEfficiencyCurve)
bool openstudio::model::BoilerHotWater::setOptimumPartLoadRatio ( double  optimumPartLoadRatio)
bool openstudio::model::BoilerHotWater::setParasiticElectricLoad ( double  parasiticElectricLoad)
bool openstudio::model::BoilerHotWater::setSizingFactor ( double  sizingFactor)
bool openstudio::model::BoilerHotWater::setWaterOutletUpperTemperatureLimit ( double  waterOutletUpperTemperatureLimit)
double openstudio::model::BoilerHotWater::sizingFactor ( ) const
static std::vector<std::string> openstudio::model::BoilerHotWater::validBoilerFlowModeValues ( )
static std::vector<std::string> openstudio::model::BoilerHotWater::validEfficiencyCurveTemperatureEvaluationVariableValues ( )
static std::vector<std::string> openstudio::model::BoilerHotWater::validFuelTypeValues ( )
double openstudio::model::BoilerHotWater::waterOutletUpperTemperatureLimit ( ) const

Friends And Related Function Documentation

typedef std::vector<BoilerHotWater> BoilerHotWaterVector
typedef boost::optional<BoilerHotWater> OptionalBoilerHotWater