OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Pages

#include "GasEquipment.hpp"

Inheritance diagram for openstudio::model::GasEquipment:

Public Member Functions

 GasEquipment (const GasEquipmentDefinition &gasEquipmentDefinition)
virtual ~GasEquipment ()
GasEquipmentDefinition gasEquipmentDefinition () const
boost::optional< Scheduleschedule () const
bool isScheduleDefaulted () const
std::string endUseSubcategory () const
bool isEndUseSubcategoryDefaulted () const
bool setGasEquipmentDefinition (const GasEquipmentDefinition &definition)
bool setSchedule (Schedule &schedule)
void resetSchedule ()
bool setMultiplier (double multiplier)
void resetMultiplier ()
bool setEndUseSubcategory (std::string endUseSubcategory)
void resetEndUseSubcategory ()
boost::optional< double > designLevel () const
boost::optional< double > powerPerFloorArea () const
boost::optional< double > powerPerPerson () const
double getDesignLevel (double floorArea, double numPeople) const
double getPowerPerFloorArea (double floorArea, double numPeople) const
double getPowerPerPerson (double floorArea, double numPeople) const

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

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

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.

bool 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