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

#include <LightsDefinition.hpp>

+ Inheritance diagram for openstudio::model::LightsDefinition:

Public Member Functions

Constructors and Destructors
 LightsDefinition (const Model &model)
 
virtual ~LightsDefinition ()=default
 
 LightsDefinition (const LightsDefinition &other)=default
 
 LightsDefinition (LightsDefinition &&other)=default
 
LightsDefinitionoperator= (const LightsDefinition &)=default
 
LightsDefinitionoperator= (LightsDefinition &&)=default
 
Getters
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
 
Setters
bool setLightingLevel (double lightingLevel)
 Sets designLevelCalculationMethod to 'LightingLevel', clears wattsperSpaceFloorArea and wattsperPerson, and sets lightingLevel. More...
 
bool setWattsperSpaceFloorArea (double wattsperSpaceFloorArea)
 Sets designLevelCalculationMethod to 'Watts/Area', clears lightingLevel and wattsperPerson, and sets wattsperSpaceFloorArea. More...
 
bool setWattsperPerson (double wattsperPerson)
 Sets designLevelCalculationMethod to 'Watts/Person', clears lightingLevel and wattsperSpaceFloorArea, and sets wattsperPerson. More...
 
bool setFractionRadiant (double fractionRadiant)
 
void resetFractionRadiant ()
 
bool setFractionVisible (double fractionVisible)
 
void resetFractionVisible ()
 
bool setReturnAirFraction (double returnAirFraction)
 
void resetReturnAirFraction ()
 
bool setReturnAirFractionCalculatedfromPlenumTemperature (bool returnAirFractionCalculatedfromPlenumTemperature)
 
void resetReturnAirFractionCalculatedfromPlenumTemperature ()
 
bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient1 (double returnAirFractionFunctionofPlenumTemperatureCoefficient1)
 
void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ()
 
bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient2 (double returnAirFractionFunctionofPlenumTemperatureCoefficient2)
 
void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ()
 
Other
double getLightingPower (double floorArea, double numPeople) const
 Returns the lighting level represented by this definition, assuming floorArea (m^2) and numPeople. More...
 
double getPowerPerFloorArea (double floorArea, double numPeople) const
 Returns the watts/m^2 represented by this definition, assuming floorArea (m^2) and numPeople. More...
 
double getPowerPerPerson (double floorArea, double numPeople) const
 Returns the watts/person represented by this definition, assuming floorArea (m^2) and numPeople. More...
 
bool 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. More...
 
- Public Member Functions inherited from openstudio::model::SpaceLoadDefinition
double floorArea () const
 Returns the floor area associated with instances of this space load definition. More...
 
std::vector< SpaceLoadInstanceinstances () const
 Returns all instances of this definition. More...
 
SpaceLoadDefinitionoperator= (const SpaceLoadDefinition &)=default
 
SpaceLoadDefinitionoperator= (SpaceLoadDefinition &&)=default
 
int quantity () const
 Returns the number of instances of this space load. More...
 
 SpaceLoadDefinition (const SpaceLoadDefinition &other)=default
 
 SpaceLoadDefinition (SpaceLoadDefinition &&other)=default
 
virtual ~SpaceLoadDefinition ()=default
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=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 ()
 
static std::vector< std::string > validDesignLevelCalculationMethodValues ()
 

Related Functions

(Note that these are not member functions.)

using LightsDefinitionVector = std::vector< LightsDefinition >
 
using OptionalLightsDefinition = boost::optional< LightsDefinition >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::SpaceLoadDefinition
 SpaceLoadDefinition (IddObjectType type, const Model &model)
 Constructs a new SpaceLoadDefinition object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject 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

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 ( )
virtualdefault
openstudio::model::LightsDefinition::LightsDefinition ( const LightsDefinition other)
default
openstudio::model::LightsDefinition::LightsDefinition ( LightsDefinition &&  other)
default

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
LightsDefinition& openstudio::model::LightsDefinition::operator= ( const LightsDefinition )
default
LightsDefinition& openstudio::model::LightsDefinition::operator= ( LightsDefinition &&  )
default
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)
bool 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

using LightsDefinitionVector = std::vector<LightsDefinition>
related
using OptionalLightsDefinition = boost::optional<LightsDefinition>
related