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

#include <Luminaire.hpp>

+ Inheritance diagram for openstudio::model::Luminaire:

Public Member Functions

Constructors and Destructors
 Luminaire (const LuminaireDefinition &luminaireDefinition)
 
virtual ~Luminaire ()
 
Getters
LuminaireDefinition luminaireDefinition () const
 Gets the LuminaireDefinition object. More...
 
boost::optional< Scheduleschedule () const
 Returns the (fractional) lighting schedule. More...
 
bool isScheduleDefaulted () const
 Returns true if this object does not specify a schedule directly. More...
 
double positionXcoordinate () const
 
double positionYcoordinate () const
 
double positionZcoordinate () const
 
double psiRotationAroundXaxis () const
 
bool isPsiRotationAroundXaxisDefaulted () const
 
double thetaRotationAroundYaxis () const
 
bool isThetaRotationAroundYaxisDefaulted () const
 
double phiRotationAroundZaxis () const
 
bool isPhiRotationAroundZaxisDefaulted () const
 
double fractionReplaceable () const
 
bool isFractionReplaceableDefaulted () const
 
std::string endUseSubcategory () const
 
bool isEndUseSubcategoryDefaulted () const
 
Setters
bool setLuminaireDefinition (const LuminaireDefinition &definition)
 Sets the LuminaireDefinition object. More...
 
bool setSchedule (Schedule &schedule)
 Sets the (fractional) Schedule. More...
 
void resetSchedule ()
 Resets the (fractional) Schedule. More...
 
bool setPositionXcoordinate (double positionXcoordinate)
 
bool setPositionYcoordinate (double positionYcoordinate)
 
bool setPositionZcoordinate (double positionZcoordinate)
 
bool setPsiRotationAroundXaxis (double psiRotationAroundXaxis)
 
void resetPsiRotationAroundXaxis ()
 
bool setThetaRotationAroundYaxis (double thetaRotationAroundYaxis)
 
void resetThetaRotationAroundYaxis ()
 
bool setPhiRotationAroundZaxis (double phiRotationAroundZaxis)
 
void resetPhiRotationAroundZaxis ()
 
bool setFractionReplaceable (double fractionReplaceable)
 
void resetFractionReplaceable ()
 
bool setMultiplier (double multiplier)
 
void resetMultiplier ()
 
bool setEndUseSubcategory (std::string endUseSubcategory)
 
void resetEndUseSubcategory ()
 
Other
openstudio::Point3d position () const
 Returns a Point3d representing position only in meters relative to the Space. More...
 
bool setPosition (const openstudio::Point3d &position)
 Sets a Point3d representing position only position in meters relative to the Space. More...
 
openstudio::Transformation transformation () const
 Returns a Transformation representing position and orientation in meters relative to the Space. More...
 
bool setTransformation (const openstudio::Transformation &transformation)
 Sets a Transformation representing position and orientation in meters relative to the Space. More...
 
double lightingPower () const
 Returns the design level represented by this instance. More...
 
double getPowerPerFloorArea (double floorArea) const
 Returns the watts/m^2 represented by this instance, assuming floorArea (m^2). More...
 
double getPowerPerPerson (double numPeople) const
 Returns the watts/person represented by this instance, assuming 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...
 
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 (std::string valueName, std::string unitString) 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 ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector< LuminaireLuminaireVector
 
typedef boost::optional
< Luminaire
OptionalLuminaire
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_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)
 

Detailed Description

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

See also
LuminaireDefinition

Constructor & Destructor Documentation

openstudio::model::Luminaire::Luminaire ( const LuminaireDefinition luminaireDefinition)
explicit
virtual openstudio::model::Luminaire::~Luminaire ( )
inlinevirtual

Member Function Documentation

std::string openstudio::model::Luminaire::endUseSubcategory ( ) const
double openstudio::model::Luminaire::fractionReplaceable ( ) const
double openstudio::model::Luminaire::getPowerPerFloorArea ( double  floorArea) const

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

double openstudio::model::Luminaire::getPowerPerPerson ( double  numPeople) const

Returns the watts/person represented by this instance, assuming numPeople.

static IddObjectType openstudio::model::Luminaire::iddObjectType ( )
static
bool openstudio::model::Luminaire::isEndUseSubcategoryDefaulted ( ) const
bool openstudio::model::Luminaire::isFractionReplaceableDefaulted ( ) const
bool openstudio::model::Luminaire::isPhiRotationAroundZaxisDefaulted ( ) const
bool openstudio::model::Luminaire::isPsiRotationAroundXaxisDefaulted ( ) const
bool openstudio::model::Luminaire::isScheduleDefaulted ( ) const

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

bool openstudio::model::Luminaire::isThetaRotationAroundYaxisDefaulted ( ) const
double openstudio::model::Luminaire::lightingPower ( ) const

Returns the design level represented by this instance.

LuminaireDefinition openstudio::model::Luminaire::luminaireDefinition ( ) const

Gets the LuminaireDefinition object.

double openstudio::model::Luminaire::phiRotationAroundZaxis ( ) const
openstudio::Point3d openstudio::model::Luminaire::position ( ) const

Returns a Point3d representing position only in meters relative to the Space.

double openstudio::model::Luminaire::positionXcoordinate ( ) const
double openstudio::model::Luminaire::positionYcoordinate ( ) const
double openstudio::model::Luminaire::positionZcoordinate ( ) const
double openstudio::model::Luminaire::psiRotationAroundXaxis ( ) const
void openstudio::model::Luminaire::resetEndUseSubcategory ( )
void openstudio::model::Luminaire::resetFractionReplaceable ( )
void openstudio::model::Luminaire::resetMultiplier ( )
void openstudio::model::Luminaire::resetPhiRotationAroundZaxis ( )
void openstudio::model::Luminaire::resetPsiRotationAroundXaxis ( )
void openstudio::model::Luminaire::resetSchedule ( )

Resets the (fractional) Schedule.

void openstudio::model::Luminaire::resetThetaRotationAroundYaxis ( )
boost::optional<Schedule> openstudio::model::Luminaire::schedule ( ) const

Returns the (fractional) lighting schedule.

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

bool openstudio::model::Luminaire::setEndUseSubcategory ( std::string  endUseSubcategory)
bool openstudio::model::Luminaire::setFractionReplaceable ( double  fractionReplaceable)
bool openstudio::model::Luminaire::setLuminaireDefinition ( const LuminaireDefinition definition)

Sets the LuminaireDefinition object.

bool openstudio::model::Luminaire::setMultiplier ( double  multiplier)
bool openstudio::model::Luminaire::setPhiRotationAroundZaxis ( double  phiRotationAroundZaxis)
bool openstudio::model::Luminaire::setPosition ( const openstudio::Point3d &  position)

Sets a Point3d representing position only position in meters relative to the Space.

Does not change the orientation of the Luminaire.

bool openstudio::model::Luminaire::setPositionXcoordinate ( double  positionXcoordinate)
bool openstudio::model::Luminaire::setPositionYcoordinate ( double  positionYcoordinate)
bool openstudio::model::Luminaire::setPositionZcoordinate ( double  positionZcoordinate)
bool openstudio::model::Luminaire::setPsiRotationAroundXaxis ( double  psiRotationAroundXaxis)
bool openstudio::model::Luminaire::setSchedule ( Schedule schedule)

Sets the (fractional) Schedule.

bool openstudio::model::Luminaire::setThetaRotationAroundYaxis ( double  thetaRotationAroundYaxis)
bool openstudio::model::Luminaire::setTransformation ( const openstudio::Transformation &  transformation)

Sets a Transformation representing position and orientation in meters relative to the Space.

double openstudio::model::Luminaire::thetaRotationAroundYaxis ( ) const
openstudio::Transformation openstudio::model::Luminaire::transformation ( ) const

Returns a Transformation representing position and orientation in meters relative to the Space.

Friends And Related Function Documentation

typedef std::vector<Luminaire> LuminaireVector
related
typedef boost::optional<Luminaire> OptionalLuminaire
related