#include <BoilerSteam.hpp>
Public Member Functions | |
boost::optional< double > | autosizedNominalCapacity () const |
BoilerSteam (const Model &model) | |
virtual | ~BoilerSteam () |
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< AirLoopHVAC > | airLoopHVAC () const |
Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More... | |
ModelObject | clone (Model model) const |
void | disconnect () |
boost::optional< ModelObject > | inletModelObject () const |
Returns the optional ModelObject connected to the inlet port. More... | |
unsigned | inletPort () const |
Returns the inlet port. More... | |
boost::optional< ModelObject > | outletModelObject () const |
Returns the optional ModelObject connected to the outlet port. More... | |
unsigned | outletPort () const |
Returns the outlet port. More... | |
std::vector < openstudio::IdfObject > | remove () |
bool | removeFromLoop () |
StraightComponent (IddObjectType type, const Model &model) | |
virtual | ~StraightComponent () |
Public Member Functions inherited from openstudio::model::HVACComponent | |
bool | addToNode (Node &node) |
Adds this object to a new system node and returns a boolean indicating if the addition was successful. More... | |
bool | addToSplitter (Splitter &splitter) |
Adds this object to a splitter by creating a new branch. More... | |
boost::optional< AirLoopHVAC > | airLoopHVAC () const |
Returns the optional AirLoopHVAC object that the HVAC component is attached to. More... | |
boost::optional < AirLoopHVACOutdoorAirSystem > | airLoopHVACOutdoorAirSystem () const |
Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More... | |
void | applySizingValues () |
void | autosize () |
Returns the optional ModelObject connected to this object's port. More... | |
boost::optional< HVACComponent > | containingHVACComponent () const |
EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More... | |
boost::optional < StraightComponent > | containingStraightComponent () const |
boost::optional < ZoneHVACComponent > | containingZoneHVACComponent () const |
Returns any ZoneHVACComponent that contains this HVACComponent. More... | |
void | disconnect () |
Removes all connections to other HVACComponent objects. More... | |
bool | isRemovable () const |
Indicates if the HVACComponent can be removed from the model. More... | |
boost::optional< Loop > | loop () const |
Returns the optional Loop object that the HVAC component is attached to. More... | |
boost::optional< PlantLoop > | plantLoop () const |
Returns the optional PlantLoop object that the HVAC component is attached to. More... | |
std::vector< IdfObject > | remove () |
Removes the HVACComponent from the model only if isRemovable() return true. More... | |
virtual | ~HVACComponent () |
Public Member Functions inherited from openstudio::model::ParentObject | |
std::vector< IddObjectType > | allowableChildTypes () const |
Returns a vector of allowable children types. More... | |
std::vector< ModelObject > | children () const |
Return direct child objects in the Model. More... | |
virtual | ~ParentObject () |
Public Member Functions inherited from openstudio::model::ModelObject | |
virtual | ~ModelObject () |
ModelObject | clone () const |
Creates a deep copy of this object, placing it in this object's model(). More... | |
ModelObject | clone (Model model) const |
Creates a deep copy of this object, placing it in model. More... | |
Component | createComponent () const |
Method for creating sharable Model snippets. More... | |
Model | model () const |
Returns the Model that contains this object. More... | |
boost::optional< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () const |
Get the resources directly used by this ModelObject. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources () const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
boost::optional< T > | getModelObjectTarget (unsigned index) const |
Get the object of type T pointed to by this object from field index. More... | |
template<typename T > | |
std::vector< T > | getModelObjectTargets () const |
Get all objects of type T to which this object points. More... | |
const std::vector< std::string > & | outputVariableNames () const |
Get all output variables names that could be associated with this object. More... | |
std::vector< OutputVariable > | outputVariables () const |
Get all output variables associated with this object, must run simulation to generate data. More... | |
boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
Get data associated with this output variable and this object. More... | |
std::vector< LifeCycleCost > | lifeCycleCosts () const |
Returns the list of all LifeCycleCosts that refer to this object. More... | |
std::vector< IdfObject > | removeLifeCycleCosts () |
Removes all LifeCycleCosts that refer to this object. More... | |
IddObjectType | iddObjectType () const |
This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
AdditionalProperties | additionalProperties () const |
Returns this object's additional properties, constructing a new object if necessary. More... | |
bool | hasAdditionalProperties () const |
Returns true if this object has additional properties. More... | |
std::vector< IdfObject > | removeAdditionalProperties () |
Removes all additional properties that refer to this object. More... | |
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< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
Gets the autosized component value from the sql file. More... | |
virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
Return the names of the available ems actuators. More... | |
virtual std::vector< std::string > | emsInternalVariableNames () const |
Return the names of the available ems internal variables. More... | |
boost::optional< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
static std::vector< std::string > | fuelTypeValues () |
static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
typedef std::vector< BoilerSteam > | BoilerSteamVector |
typedef boost::optional < BoilerSteam > | OptionalBoilerSteam |
Related Functions inherited from openstudio::model::ParentObject | |
std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
Protected Types inherited from openstudio::model::HVACComponent | |
typedef detail::HVACComponent_Impl | ImplType |
Protected Types inherited from openstudio::model::ModelObject | |
typedef detail::ModelObject_Impl | ImplType |
Protected Member Functions inherited from openstudio::model::HVACComponent | |
virtual std::vector< ModelObject > | children () const |
HVACComponent (IddObjectType type, const Model &model) | |
HVACComponent (std::shared_ptr< ImplType > impl) | |
Protected Member Functions inherited from openstudio::model::ParentObject | |
ParentObject (IddObjectType type, const Model &model) | |
Constructs a new ParentObject object in the model. More... | |
Protected Member Functions inherited from openstudio::model::ModelObject | |
ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
BoilerSteam is a StraightComponent that wraps the OpenStudio IDD object 'OS:Boiler:Steam'.
|
explicit |
|
inlinevirtual |
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 |
|
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 |
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 |
|
related |
|
related |