OpenStudioCore:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "LightsDefinition.hpp"

Inheritance diagram for openstudio::model::LightsDefinition:

Public Member Functions

 LightsDefinition (const Model &model)
virtual ~LightsDefinition ()
std::string designLevelCalculationMethod () const
boost::optional< double > lightingLevel () const
boost::optional< double > wattsperSpaceFloorArea () const
boost::optional< double > wattsperPerson () const
double fractionRadiant () const
bool isFractionRadiantDefaulted () const
double fractionVisible () const
bool isFractionVisibleDefaulted () const
double returnAirFraction () const
bool isReturnAirFractionDefaulted () const
bool returnAirFractionCalculatedfromPlenumTemperature () const
bool isReturnAirFractionCalculatedfromPlenumTemperatureDefaulted () const
double returnAirFractionFunctionofPlenumTemperatureCoefficient1 () const
bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient1Defaulted () const
double returnAirFractionFunctionofPlenumTemperatureCoefficient2 () const
bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient2Defaulted () const
bool setLightingLevel (double lightingLevel)
bool setWattsperSpaceFloorArea (double wattsperSpaceFloorArea)
bool setWattsperPerson (double wattsperPerson)
bool setFractionRadiant (double fractionRadiant)
void resetFractionRadiant ()
bool setFractionVisible (double fractionVisible)
void resetFractionVisible ()
bool setReturnAirFraction (double returnAirFraction)
void resetReturnAirFraction ()
void setReturnAirFractionCalculatedfromPlenumTemperature (bool returnAirFractionCalculatedfromPlenumTemperature)
void resetReturnAirFractionCalculatedfromPlenumTemperature ()
bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient1 (double returnAirFractionFunctionofPlenumTemperatureCoefficient1)
void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ()
bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient2 (double returnAirFractionFunctionofPlenumTemperatureCoefficient2)
void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ()
double getLightingPower (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
< LightsDefinition
LightsDefinitionVector
typedef boost::optional
< LightsDefinition
OptionalLightsDefinition

Detailed Description

LightsDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_Lights_Definition'.

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

See also
Lights

Constructor & Destructor Documentation

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

Member Function Documentation

std::string openstudio::model::LightsDefinition::designLevelCalculationMethod ( ) const
double openstudio::model::LightsDefinition::fractionRadiant ( ) const
double openstudio::model::LightsDefinition::fractionVisible ( ) const
double openstudio::model::LightsDefinition::getLightingPower ( double  floorArea,
double  numPeople 
) const

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

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

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

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

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

static IddObjectType openstudio::model::LightsDefinition::iddObjectType ( )
static
bool openstudio::model::LightsDefinition::isFractionRadiantDefaulted ( ) const
bool openstudio::model::LightsDefinition::isFractionVisibleDefaulted ( ) const
bool openstudio::model::LightsDefinition::isReturnAirFractionCalculatedfromPlenumTemperatureDefaulted ( ) const
bool openstudio::model::LightsDefinition::isReturnAirFractionDefaulted ( ) const
bool openstudio::model::LightsDefinition::isReturnAirFractionFunctionofPlenumTemperatureCoefficient1Defaulted ( ) const
bool openstudio::model::LightsDefinition::isReturnAirFractionFunctionofPlenumTemperatureCoefficient2Defaulted ( ) const
boost::optional<double> openstudio::model::LightsDefinition::lightingLevel ( ) const
void openstudio::model::LightsDefinition::resetFractionRadiant ( )
void openstudio::model::LightsDefinition::resetFractionVisible ( )
void openstudio::model::LightsDefinition::resetReturnAirFraction ( )
void openstudio::model::LightsDefinition::resetReturnAirFractionCalculatedfromPlenumTemperature ( )
void openstudio::model::LightsDefinition::resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ( )
void openstudio::model::LightsDefinition::resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ( )
double openstudio::model::LightsDefinition::returnAirFraction ( ) const
bool openstudio::model::LightsDefinition::returnAirFractionCalculatedfromPlenumTemperature ( ) const
double openstudio::model::LightsDefinition::returnAirFractionFunctionofPlenumTemperatureCoefficient1 ( ) const
double openstudio::model::LightsDefinition::returnAirFractionFunctionofPlenumTemperatureCoefficient2 ( ) const
bool openstudio::model::LightsDefinition::setDesignLevelCalculationMethod ( const std::string &  method,
double  floorArea,
double  numPeople 
)

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

bool openstudio::model::LightsDefinition::setFractionRadiant ( double  fractionRadiant)
bool openstudio::model::LightsDefinition::setFractionVisible ( double  fractionVisible)
bool openstudio::model::LightsDefinition::setLightingLevel ( double  lightingLevel)

Sets designLevelCalculationMethod to 'LightingLevel', clears wattsperSpaceFloorArea and wattsperPerson, and sets lightingLevel.

bool openstudio::model::LightsDefinition::setReturnAirFraction ( double  returnAirFraction)
void openstudio::model::LightsDefinition::setReturnAirFractionCalculatedfromPlenumTemperature ( bool  returnAirFractionCalculatedfromPlenumTemperature)
bool openstudio::model::LightsDefinition::setReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ( double  returnAirFractionFunctionofPlenumTemperatureCoefficient1)
bool openstudio::model::LightsDefinition::setReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ( double  returnAirFractionFunctionofPlenumTemperatureCoefficient2)
bool openstudio::model::LightsDefinition::setWattsperPerson ( double  wattsperPerson)

Sets designLevelCalculationMethod to 'Watts/Person', clears lightingLevel and wattsperSpaceFloorArea, and sets wattsperPerson.

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

Sets designLevelCalculationMethod to 'Watts/Area', clears lightingLevel and wattsperPerson, and sets wattsperSpaceFloorArea.

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

Friends And Related Function Documentation

typedef std::vector<LightsDefinition> LightsDefinitionVector
related
typedef boost::optional<LightsDefinition> OptionalLightsDefinition
related