OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Pages

#include "GasEquipmentDefinition.hpp"

Inheritance diagram for openstudio::model::GasEquipmentDefinition:

Public Member Functions

 GasEquipmentDefinition (const Model &model)
virtual ~GasEquipmentDefinition ()
std::string designLevelCalculationMethod () const
boost::optional< double > designLevel () const
boost::optional< double > wattsperSpaceFloorArea () const
boost::optional< double > wattsperPerson () const
double fractionLatent () const
bool isFractionLatentDefaulted () const
double fractionRadiant () const
bool isFractionRadiantDefaulted () const
double fractionLost () const
bool isFractionLostDefaulted () const
double carbonDioxideGenerationRate () const
bool isCarbonDioxideGenerationRateDefaulted () const
bool setDesignLevel (double designLevel)
bool setWattsperSpaceFloorArea (double wattsperSpaceFloorArea)
bool setWattsperPerson (double wattsperPerson)
bool setFractionLatent (double fractionLatent)
void resetFractionLatent ()
bool setFractionRadiant (double fractionRadiant)
void resetFractionRadiant ()
bool setFractionLost (double fractionLost)
void resetFractionLost ()
bool setCarbonDioxideGenerationRate (double carbonDioxideGenerationRate)
void resetCarbonDioxideGenerationRate ()
double getDesignLevel (double floorArea, double numPeople) const
double getPowerPerFloorArea (double floorArea, double numPeople) const
double getPowerPerPerson (double floorArea, double numPeople) const
bool setDesignLevelCalculationMethod (const std::string &method, double floorArea, double numPeople)

Static Public Member Functions

static IddObjectType iddObjectType ()
static std::vector< std::string > validDesignLevelCalculationMethodValues ()

Related Functions

typedef std::vector
< GasEquipmentDefinition
GasEquipmentDefinitionVector
typedef boost::optional
< GasEquipmentDefinition
OptionalGasEquipmentDefinition

Detailed Description

GasEquipmentDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_GasEquipment_Definition'.

Its fields are derived from the EnergyPlus IDD object 'GasEquipment'.

See also
GasEquipmentDefinition

Constructor & Destructor Documentation

openstudio::model::GasEquipmentDefinition::GasEquipmentDefinition ( const Model model)
explicit
virtual openstudio::model::GasEquipmentDefinition::~GasEquipmentDefinition ( )
inlinevirtual

Member Function Documentation

double openstudio::model::GasEquipmentDefinition::carbonDioxideGenerationRate ( ) const
boost::optional<double> openstudio::model::GasEquipmentDefinition::designLevel ( ) const
std::string openstudio::model::GasEquipmentDefinition::designLevelCalculationMethod ( ) const
double openstudio::model::GasEquipmentDefinition::fractionLatent ( ) const
double openstudio::model::GasEquipmentDefinition::fractionLost ( ) const
double openstudio::model::GasEquipmentDefinition::fractionRadiant ( ) const
double openstudio::model::GasEquipmentDefinition::getDesignLevel ( double  floorArea,
double  numPeople 
) const

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

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

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

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

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

static IddObjectType openstudio::model::GasEquipmentDefinition::iddObjectType ( )
static
bool openstudio::model::GasEquipmentDefinition::isCarbonDioxideGenerationRateDefaulted ( ) const
bool openstudio::model::GasEquipmentDefinition::isFractionLatentDefaulted ( ) const
bool openstudio::model::GasEquipmentDefinition::isFractionLostDefaulted ( ) const
bool openstudio::model::GasEquipmentDefinition::isFractionRadiantDefaulted ( ) const
void openstudio::model::GasEquipmentDefinition::resetCarbonDioxideGenerationRate ( )
void openstudio::model::GasEquipmentDefinition::resetFractionLatent ( )
void openstudio::model::GasEquipmentDefinition::resetFractionLost ( )
void openstudio::model::GasEquipmentDefinition::resetFractionRadiant ( )
bool openstudio::model::GasEquipmentDefinition::setCarbonDioxideGenerationRate ( double  carbonDioxideGenerationRate)
bool openstudio::model::GasEquipmentDefinition::setDesignLevel ( double  designLevel)

Also sets designLevelCalculationMethod accordingly.

bool openstudio::model::GasEquipmentDefinition::setDesignLevelCalculationMethod ( const std::string &  method,
double  floorArea,
double  numPeople 
)

If method is a valid design level calculation method , changes this definition to an equivalent power level, under the assumptions of floorArea (m^2) and numPeople.

bool openstudio::model::GasEquipmentDefinition::setFractionLatent ( double  fractionLatent)
bool openstudio::model::GasEquipmentDefinition::setFractionLost ( double  fractionLost)
bool openstudio::model::GasEquipmentDefinition::setFractionRadiant ( double  fractionRadiant)
bool openstudio::model::GasEquipmentDefinition::setWattsperPerson ( double  wattsperPerson)

Also sets designLevelCalculationMethod accordingly.

bool openstudio::model::GasEquipmentDefinition::setWattsperSpaceFloorArea ( double  wattsperSpaceFloorArea)

Also sets designLevelCalculationMethod accordingly.

static std::vector<std::string> openstudio::model::GasEquipmentDefinition::validDesignLevelCalculationMethodValues ( )
static
boost::optional<double> openstudio::model::GasEquipmentDefinition::wattsperPerson ( ) const
boost::optional<double> openstudio::model::GasEquipmentDefinition::wattsperSpaceFloorArea ( ) const

Friends And Related Function Documentation

typedef boost::optional<GasEquipmentDefinition> OptionalGasEquipmentDefinition
related