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

#include <SteamEquipment.hpp>

+ Inheritance diagram for openstudio::model::SteamEquipment:

Public Member Functions

Constructors and Destructors
 SteamEquipment (const SteamEquipmentDefinition &definition)
 
virtual ~SteamEquipment ()=default
 
 SteamEquipment (const SteamEquipment &other)=default
 
 SteamEquipment (SteamEquipment &&other)=default
 
SteamEquipmentoperator= (const SteamEquipment &)=default
 
SteamEquipmentoperator= (SteamEquipment &&)=default
 
Getters
SteamEquipmentDefinition steamEquipmentDefinition () const
 
boost::optional< Scheduleschedule () const
 Returns the (fractional) equipment schedule. More...
 
bool isScheduleDefaulted () const
 Returns true if this object does not specify a schedule directly. More...
 
std::string endUseSubcategory () const
 
bool isEndUseSubcategoryDefaulted () const
 
Setters
bool setSteamEquipmentDefinition (const SteamEquipmentDefinition &definition)
 
bool setSchedule (Schedule &schedule)
 Sets the (fractional) Schedule. More...
 
void resetSchedule ()
 Resets the (fractional) Schedule. More...
 
bool setMultiplier (double multiplier)
 
void resetMultiplier ()
 
bool setEndUseSubcategory (const std::string &endUseSubcategory)
 
void resetEndUseSubcategory ()
 
Other
double getDesignLevel (double floorArea, double numPeople) const
 Returns the design level represented by this instance, assuming floorArea (m^2) and numPeople. More...
 
double getPowerPerFloorArea (double floorArea, double numPeople) const
 Returns the watts/m^2 represented by this instance, assuming floorArea (m^2) and numPeople. More...
 
double getPowerPerPerson (double floorArea, double numPeople) const
 Returns the watts/person represented by this instance, assuming floorArea (m^2) and numPeople. More...
 
- Public Member Functions inherited from openstudio::model::SpaceLoadInstance
SpaceLoadDefinition definition () const
 Returns the definition of this instance. More...
 
double floorArea () const
 Returns the floor area associated with this space load instance. More...
 
bool isMultiplierDefaulted () const
 Returns true if the multiplier is defaulted. More...
 
void makeUnique ()
 Ensures that no other instances share this instances definition. More...
 
double multiplier () const
 Gets the multiplier for this space instance, defaults to 1. More...
 
SpaceLoadInstanceoperator= (const SpaceLoadInstance &)=default
 
SpaceLoadInstanceoperator= (SpaceLoadInstance &&)=default
 
int quantity () const
 Returns the number of instances this space load instance represents. More...
 
bool setDefinition (const SpaceLoadDefinition &definition)
 Sets the definition of this instance. More...
 
 SpaceLoadInstance (const SpaceLoadInstance &other)=default
 
 SpaceLoadInstance (SpaceLoadInstance &&other)=default
 
virtual ~SpaceLoadInstance ()=default
 
- Public Member Functions inherited from openstudio::model::SpaceLoad
bool hardApplySchedules ()
 Directly applies default schedules to this space load if found. More...
 
bool hardSize ()
 Converts space load levels to absolute values rather than by per area, etc. More...
 
bool isAbsolute () const
 Returns true if the load represents an absolute quantity that must be added when combining space types. More...
 
SpaceLoadoperator= (const SpaceLoad &)=default
 
SpaceLoadoperator= (SpaceLoad &&)=default
 
void resetSpaceType ()
 
bool setSpaceType (const SpaceType &spaceType)
 Sets the parent SpaceType. More...
 
 SpaceLoad (const SpaceLoad &other)=default
 
 SpaceLoad (SpaceLoad &&other)=default
 
boost::optional< SpaceTypespaceType () const
 Returns the parent SpaceType. More...
 
virtual ~SpaceLoad ()=default
 
- Public Member Functions inherited from openstudio::model::SpaceItem
SpaceItemoperator= (const SpaceItem &)=default
 
SpaceItemoperator= (SpaceItem &&)=default
 
void resetSpace ()
 
bool setSpace (const Space &space)
 Sets the parent Space. More...
 
boost::optional< Spacespace () const
 Returns the parent Space. More...
 
 SpaceItem (const SpaceItem &other)=default
 
 SpaceItem (SpaceItem &&other)=default
 
virtual ~SpaceItem ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
boost::optional
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObject > removeLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
 
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test More...
 
bool operator!= (const ModelObject &other) const
 inequality test More...
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file. More...
 
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

using OptionalSteamEquipment = boost::optional< SteamEquipment >
 
using SteamEquipmentVector = std::vector< SteamEquipment >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::SpaceLoadInstance
 SpaceLoadInstance (IddObjectType type, const SpaceLoadDefinition &definition)
 Constructs a new SpaceLoadInstance object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::SpaceLoad
 SpaceLoad (IddObjectType type, const Model &model)
 Constructs a new SpaceLoad object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::SpaceItem
 SpaceItem (IddObjectType type, const Model &model)
 Constructs a new SpaceItem object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
 

Detailed Description

SteamEquipment is a SpaceLoadInstance that wraps the OpenStudio IDD object 'OS:SteamEquipment'.

See also
SteamEquipmentDefinition

Constructor & Destructor Documentation

openstudio::model::SteamEquipment::SteamEquipment ( const SteamEquipmentDefinition definition)
explicit
virtual openstudio::model::SteamEquipment::~SteamEquipment ( )
virtualdefault
openstudio::model::SteamEquipment::SteamEquipment ( const SteamEquipment other)
default
openstudio::model::SteamEquipment::SteamEquipment ( SteamEquipment &&  other)
default

Member Function Documentation

std::string openstudio::model::SteamEquipment::endUseSubcategory ( ) const
double openstudio::model::SteamEquipment::getDesignLevel ( double  floorArea,
double  numPeople 
) const

Returns the design level represented by this instance, assuming floorArea (m^2) and numPeople.

double openstudio::model::SteamEquipment::getPowerPerFloorArea ( double  floorArea,
double  numPeople 
) const

Returns the watts/m^2 represented by this instance, assuming floorArea (m^2) and numPeople.

double openstudio::model::SteamEquipment::getPowerPerPerson ( double  floorArea,
double  numPeople 
) const

Returns the watts/person represented by this instance, assuming floorArea (m^2) and numPeople.

static IddObjectType openstudio::model::SteamEquipment::iddObjectType ( )
static
bool openstudio::model::SteamEquipment::isEndUseSubcategoryDefaulted ( ) const
bool openstudio::model::SteamEquipment::isScheduleDefaulted ( ) const

Returns true if this object does not specify a schedule directly.

SteamEquipment& openstudio::model::SteamEquipment::operator= ( const SteamEquipment )
default
SteamEquipment& openstudio::model::SteamEquipment::operator= ( SteamEquipment &&  )
default
void openstudio::model::SteamEquipment::resetEndUseSubcategory ( )
void openstudio::model::SteamEquipment::resetMultiplier ( )
void openstudio::model::SteamEquipment::resetSchedule ( )

Resets the (fractional) Schedule.

boost::optional<Schedule> openstudio::model::SteamEquipment::schedule ( ) const

Returns the (fractional) equipment schedule.

If this object does not specify a schedule this function will search the hierarchy.

bool openstudio::model::SteamEquipment::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::SteamEquipment::setMultiplier ( double  multiplier)
bool openstudio::model::SteamEquipment::setSchedule ( Schedule schedule)

Sets the (fractional) Schedule.

bool openstudio::model::SteamEquipment::setSteamEquipmentDefinition ( const SteamEquipmentDefinition definition)
SteamEquipmentDefinition openstudio::model::SteamEquipment::steamEquipmentDefinition ( ) const

Friends And Related Function Documentation

using OptionalSteamEquipment = boost::optional<SteamEquipment>
related
using SteamEquipmentVector = std::vector<SteamEquipment>
related