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

#include <BoilerSteam.hpp>

+ Inheritance diagram for openstudio::model::BoilerSteam:

Public Member Functions

boost::optional< double > autosizedNominalCapacity () const
 
 BoilerSteam (const Model &model)
 
 BoilerSteam (const BoilerSteam &other)=default
 
 BoilerSteam (BoilerSteam &&other)=default
 
BoilerSteamoperator= (const BoilerSteam &)=default
 
BoilerSteamoperator= (BoilerSteam &&)=default
 
virtual ~BoilerSteam ()=default
 
Getters and Setters
std::string fuelType () const
 
bool setFuelType (const std::string &fuelType)
 
boost::optional< double > maximumOperatingPressure () const
 
bool setMaximumOperatingPressure (double maximumOperatingPressure)
 
void resetMaximumOperatingPressure ()
 
boost::optional< double > theoreticalEfficiency () const
 
bool setTheoreticalEfficiency (double theoreticalEfficiency)
 
void resetTheoreticalEfficiency ()
 
boost::optional< double > designOutletSteamTemperature () const
 
bool setDesignOutletSteamTemperature (double designOutletSteamTemperature)
 
void resetDesignOutletSteamTemperature ()
 
boost::optional< double > nominalCapacity () const
 
bool isNominalCapacityAutosized () const
 
bool setNominalCapacity (double nominalCapacity)
 
void resetNominalCapacity ()
 
void autosizeNominalCapacity ()
 
boost::optional< double > minimumPartLoadRatio () const
 
bool setMinimumPartLoadRatio (double minimumPartLoadRatio)
 
void resetMinimumPartLoadRatio ()
 
boost::optional< double > maximumPartLoadRatio () const
 
bool setMaximumPartLoadRatio (double maximumPartLoadRatio)
 
void resetMaximumPartLoadRatio ()
 
boost::optional< double > optimumPartLoadRatio () const
 
bool setOptimumPartLoadRatio (double optimumPartLoadRatio)
 
void resetOptimumPartLoadRatio ()
 
boost::optional< double > coefficient1ofFuelUseFunctionofPartLoadRatioCurve () const
 
bool setCoefficient1ofFuelUseFunctionofPartLoadRatioCurve (double coefficient1ofFuelUseFunctionofPartLoadRatioCurve)
 
void resetCoefficient1ofFuelUseFunctionofPartLoadRatioCurve ()
 
boost::optional< double > coefficient2ofFuelUseFunctionofPartLoadRatioCurve () const
 
bool setCoefficient2ofFuelUseFunctionofPartLoadRatioCurve (double coefficient2ofFuelUseFunctionofPartLoadRatioCurve)
 
void resetCoefficient2ofFuelUseFunctionofPartLoadRatioCurve ()
 
boost::optional< double > coefficient3ofFuelUseFunctionofPartLoadRatioCurve () const
 
bool setCoefficient3ofFuelUseFunctionofPartLoadRatioCurve (double coefficient3ofFuelUseFunctionofPartLoadRatioCurve)
 
void resetCoefficient3ofFuelUseFunctionofPartLoadRatioCurve ()
 
double sizingFactor () const
 
bool isSizingFactorDefaulted () const
 
bool setSizingFactor (double sizingFactor)
 
void resetSizingFactor ()
 
std::string endUseSubcategory () 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...
 
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< 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 > fuelTypeValues ()
 
static IddObjectType iddObjectType ()
 
- 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 BoilerSteamVector = std::vector< BoilerSteam >
 
using OptionalBoilerSteam = boost::optional< BoilerSteam >
 

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

BoilerSteam is a StraightComponent that wraps the OpenStudio IDD object 'OS:Boiler:Steam'.

Constructor & Destructor Documentation

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

Member Function Documentation

boost::optional<double> openstudio::model::BoilerSteam::autosizedNominalCapacity ( ) const
void openstudio::model::BoilerSteam::autosizeNominalCapacity ( )
boost::optional<double> openstudio::model::BoilerSteam::coefficient1ofFuelUseFunctionofPartLoadRatioCurve ( ) const
boost::optional<double> openstudio::model::BoilerSteam::coefficient2ofFuelUseFunctionofPartLoadRatioCurve ( ) const
boost::optional<double> openstudio::model::BoilerSteam::coefficient3ofFuelUseFunctionofPartLoadRatioCurve ( ) const
boost::optional<double> openstudio::model::BoilerSteam::designOutletSteamTemperature ( ) const
std::string openstudio::model::BoilerSteam::endUseSubcategory ( ) const
std::string openstudio::model::BoilerSteam::fuelType ( ) const
static std::vector<std::string> openstudio::model::BoilerSteam::fuelTypeValues ( )
static
static IddObjectType openstudio::model::BoilerSteam::iddObjectType ( )
static
bool openstudio::model::BoilerSteam::isNominalCapacityAutosized ( ) const
bool openstudio::model::BoilerSteam::isSizingFactorDefaulted ( ) const
boost::optional<double> openstudio::model::BoilerSteam::maximumOperatingPressure ( ) const
boost::optional<double> openstudio::model::BoilerSteam::maximumPartLoadRatio ( ) const
boost::optional<double> openstudio::model::BoilerSteam::minimumPartLoadRatio ( ) const
boost::optional<double> openstudio::model::BoilerSteam::nominalCapacity ( ) const
BoilerSteam& openstudio::model::BoilerSteam::operator= ( const BoilerSteam )
default
BoilerSteam& openstudio::model::BoilerSteam::operator= ( BoilerSteam &&  )
default
boost::optional<double> openstudio::model::BoilerSteam::optimumPartLoadRatio ( ) const
void openstudio::model::BoilerSteam::resetCoefficient1ofFuelUseFunctionofPartLoadRatioCurve ( )
void openstudio::model::BoilerSteam::resetCoefficient2ofFuelUseFunctionofPartLoadRatioCurve ( )
void openstudio::model::BoilerSteam::resetCoefficient3ofFuelUseFunctionofPartLoadRatioCurve ( )
void openstudio::model::BoilerSteam::resetDesignOutletSteamTemperature ( )
void openstudio::model::BoilerSteam::resetMaximumOperatingPressure ( )
void openstudio::model::BoilerSteam::resetMaximumPartLoadRatio ( )
void openstudio::model::BoilerSteam::resetMinimumPartLoadRatio ( )
void openstudio::model::BoilerSteam::resetNominalCapacity ( )
void openstudio::model::BoilerSteam::resetOptimumPartLoadRatio ( )
void openstudio::model::BoilerSteam::resetSizingFactor ( )
void openstudio::model::BoilerSteam::resetTheoreticalEfficiency ( )
bool openstudio::model::BoilerSteam::setCoefficient1ofFuelUseFunctionofPartLoadRatioCurve ( double  coefficient1ofFuelUseFunctionofPartLoadRatioCurve)
bool openstudio::model::BoilerSteam::setCoefficient2ofFuelUseFunctionofPartLoadRatioCurve ( double  coefficient2ofFuelUseFunctionofPartLoadRatioCurve)
bool openstudio::model::BoilerSteam::setCoefficient3ofFuelUseFunctionofPartLoadRatioCurve ( double  coefficient3ofFuelUseFunctionofPartLoadRatioCurve)
bool openstudio::model::BoilerSteam::setDesignOutletSteamTemperature ( double  designOutletSteamTemperature)
bool openstudio::model::BoilerSteam::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::BoilerSteam::setFuelType ( const std::string &  fuelType)
bool openstudio::model::BoilerSteam::setMaximumOperatingPressure ( double  maximumOperatingPressure)
bool openstudio::model::BoilerSteam::setMaximumPartLoadRatio ( double  maximumPartLoadRatio)
bool openstudio::model::BoilerSteam::setMinimumPartLoadRatio ( double  minimumPartLoadRatio)
bool openstudio::model::BoilerSteam::setNominalCapacity ( double  nominalCapacity)
bool openstudio::model::BoilerSteam::setOptimumPartLoadRatio ( double  optimumPartLoadRatio)
bool openstudio::model::BoilerSteam::setSizingFactor ( double  sizingFactor)
bool openstudio::model::BoilerSteam::setTheoreticalEfficiency ( double  theoreticalEfficiency)
double openstudio::model::BoilerSteam::sizingFactor ( ) const
boost::optional<double> openstudio::model::BoilerSteam::theoreticalEfficiency ( ) const

Friends And Related Function Documentation

using BoilerSteamVector = std::vector<BoilerSteam>
related
using OptionalBoilerSteam = boost::optional<BoilerSteam>
related