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

#include <GasEquipment.hpp>

+ Inheritance diagram for openstudio::model::GasEquipment:

Public Member Functions

Constructors and Destructors
 GasEquipment (const GasEquipmentDefinition &gasEquipmentDefinition)
 
virtual ~GasEquipment ()
 
Getters
GasEquipmentDefinition gasEquipmentDefinition () const
 Gets the GasEquipmentDefinition object. More...
 
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 setGasEquipmentDefinition (const GasEquipmentDefinition &definition)
 Sets the GasEquipmentDefinition object. More...
 
bool setSchedule (Schedule &schedule)
 Sets the (fractional) Schedule. More...
 
void resetSchedule ()
 Resets the (fractional) Schedule. More...
 
bool setMultiplier (double multiplier)
 
void resetMultiplier ()
 
void setEndUseSubcategory (std::string endUseSubcategory)
 
void resetEndUseSubcategory ()
 
Other
boost::optional< double > designLevel () const
 Returns the designLevel if possible based on the underlying data of gasEquipmentDefinition(). More...
 
boost::optional< double > powerPerFloorArea () const
 Returns the powerPerFloorArea if possible based on the underlying data of gasEquipmentDefinition(). More...
 
boost::optional< double > powerPerPerson () const
 Returns the powerPerPerson if possible based on the underlying data of gasEquipmentDefinition(). More...
 
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...
 
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...
 
virtual ~SpaceLoadInstance ()
 
- 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...
 
void resetSpaceType ()
 
bool setSpaceType (const SpaceType &spaceType)
 Sets the parent SpaceType. More...
 
boost::optional< SpaceTypespaceType () const
 Returns the parent SpaceType. More...
 
virtual ~SpaceLoad ()
 
- Public Member Functions inherited from openstudio::model::SpaceItem
void resetSpace ()
 
bool setSpace (const Space &space)
 Sets the parent Space. More...
 
boost::optional< Spacespace () const
 Returns the parent Space. More...
 
virtual ~SpaceItem ()
 
- 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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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...
 
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< 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)
 
std::vector
< 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) 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=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

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.)

typedef std::vector< GasEquipmentGasEquipmentVector
 
typedef boost::optional
< GasEquipment
OptionalGasEquipment
 

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::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- 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::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)
 
- 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

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

See also
GasEquipmentDefinition

Constructor & Destructor Documentation

openstudio::model::GasEquipment::GasEquipment ( const GasEquipmentDefinition gasEquipmentDefinition)
explicit
virtual openstudio::model::GasEquipment::~GasEquipment ( )
inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::GasEquipment::designLevel ( ) const

Returns the designLevel if possible based on the underlying data of gasEquipmentDefinition().

std::string openstudio::model::GasEquipment::endUseSubcategory ( ) const
GasEquipmentDefinition openstudio::model::GasEquipment::gasEquipmentDefinition ( ) const

Gets the GasEquipmentDefinition object.

double openstudio::model::GasEquipment::getDesignLevel ( double  floorArea,
double  numPeople 
) const

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

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

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

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

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

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

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

boost::optional<double> openstudio::model::GasEquipment::powerPerFloorArea ( ) const

Returns the powerPerFloorArea if possible based on the underlying data of gasEquipmentDefinition().

boost::optional<double> openstudio::model::GasEquipment::powerPerPerson ( ) const

Returns the powerPerPerson if possible based on the underlying data of gasEquipmentDefinition().

void openstudio::model::GasEquipment::resetEndUseSubcategory ( )
void openstudio::model::GasEquipment::resetMultiplier ( )
void openstudio::model::GasEquipment::resetSchedule ( )

Resets the (fractional) Schedule.

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

Returns the (fractional) equipment schedule.

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

void openstudio::model::GasEquipment::setEndUseSubcategory ( std::string  endUseSubcategory)
bool openstudio::model::GasEquipment::setGasEquipmentDefinition ( const GasEquipmentDefinition definition)

Sets the GasEquipmentDefinition object.

bool openstudio::model::GasEquipment::setMultiplier ( double  multiplier)
bool openstudio::model::GasEquipment::setSchedule ( Schedule schedule)

Sets the (fractional) Schedule.

Friends And Related Function Documentation

typedef std::vector<GasEquipment> GasEquipmentVector
related
typedef boost::optional<GasEquipment> OptionalGasEquipment
related