Luminaire Class Reference

#include "Luminaire.hpp"

Inheritance diagram for openstudio::model::Luminaire:

Public Member Functions
	Luminaire (const LuminaireDefinition &luminaireDefinition)
virtual	~Luminaire ()
LuminaireDefinition	luminaireDefinition () const
boost::optional< Schedule >	schedule () const
bool	isScheduleDefaulted () const
double	positionXcoordinate () const
Quantity	getPositionXcoordinate (bool returnIP=false) const
double	positionYcoordinate () const
Quantity	getPositionYcoordinate (bool returnIP=false) const
double	positionZcoordinate () const
Quantity	getPositionZcoordinate (bool returnIP=false) const
double	psiRotationAroundXaxis () const
Quantity	getPsiRotationAroundXaxis (bool returnIP=false) const
bool	isPsiRotationAroundXaxisDefaulted () const
double	thetaRotationAroundYaxis () const
Quantity	getThetaRotationAroundYaxis (bool returnIP=false) const
bool	isThetaRotationAroundYaxisDefaulted () const
double	phiRotationAroundZaxis () const
Quantity	getPhiRotationAroundZaxis (bool returnIP=false) const
bool	isPhiRotationAroundZaxisDefaulted () const
double	fractionReplaceable () const
Quantity	getFractionReplaceable (bool returnIP=false) const
bool	isFractionReplaceableDefaulted () const
std::string	endUseSubcategory () const
bool	isEndUseSubcategoryDefaulted () const
bool	setLuminaireDefinition (const LuminaireDefinition &definition)
bool	setSchedule (Schedule &schedule)
void	resetSchedule ()
bool	setPositionXcoordinate (double positionXcoordinate)
bool	setPositionXcoordinate (const Quantity &positionXcoordinate)
bool	setPositionYcoordinate (double positionYcoordinate)
bool	setPositionYcoordinate (const Quantity &positionYcoordinate)
bool	setPositionZcoordinate (double positionZcoordinate)
bool	setPositionZcoordinate (const Quantity &positionZcoordinate)
bool	setPsiRotationAroundXaxis (double psiRotationAroundXaxis)
bool	setPsiRotationAroundXaxis (const Quantity &psiRotationAroundXaxis)
void	resetPsiRotationAroundXaxis ()
bool	setThetaRotationAroundYaxis (double thetaRotationAroundYaxis)
bool	setThetaRotationAroundYaxis (const Quantity &thetaRotationAroundYaxis)
void	resetThetaRotationAroundYaxis ()
bool	setPhiRotationAroundZaxis (double phiRotationAroundZaxis)
bool	setPhiRotationAroundZaxis (const Quantity &phiRotationAroundZaxis)
void	resetPhiRotationAroundZaxis ()
bool	setFractionReplaceable (double fractionReplaceable)
bool	setFractionReplaceable (const Quantity &fractionReplaceable)
void	resetFractionReplaceable ()
bool	setMultiplier (double multiplier)
void	resetMultiplier ()
bool	setEndUseSubcategory (std::string endUseSubcategory)
void	resetEndUseSubcategory ()
openstudio::Point3d	position () const
bool	setPosition (const openstudio::Point3d &position)
openstudio::Transformation	transformation () const
bool	setTransformation (const openstudio::Transformation &transformation)
double	lightingPower () const
double	getPowerPerFloorArea (double floorArea) const
double	getPowerPerPerson (double numPeople) const

Static Public Member Functions
static IddObjectType	iddObjectType ()

Related Functions
typedef std::vector< Luminaire >	LuminaireVector
typedef boost::optional < Luminaire >	OptionalLuminaire

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

Quantity openstudio::model::Luminaire::getFractionReplaceable

(

bool

returnIP = false

)

const

Quantity openstudio::model::Luminaire::getPhiRotationAroundZaxis

(

bool

returnIP = false

)

const

Quantity openstudio::model::Luminaire::getPositionXcoordinate

(

bool

returnIP = false

)

const

Quantity openstudio::model::Luminaire::getPositionYcoordinate

(

bool

returnIP = false

)

const

Quantity openstudio::model::Luminaire::getPositionZcoordinate

(

bool

returnIP = false

)

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.

Quantity openstudio::model::Luminaire::getPsiRotationAroundXaxis

(

bool

returnIP = false

)

const

Quantity openstudio::model::Luminaire::getThetaRotationAroundYaxis

(

bool

returnIP = false

)

const

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::setFractionReplaceable

(

const Quantity &

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::setPhiRotationAroundZaxis

(

const Quantity &

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::setPositionXcoordinate

(

const Quantity &

positionXcoordinate

)

bool openstudio::model::Luminaire::setPositionYcoordinate

(

double

positionYcoordinate

)

bool openstudio::model::Luminaire::setPositionYcoordinate

(

const Quantity &

positionYcoordinate

)

bool openstudio::model::Luminaire::setPositionZcoordinate

(

double

positionZcoordinate

)

bool openstudio::model::Luminaire::setPositionZcoordinate

(

const Quantity &

positionZcoordinate

)

bool openstudio::model::Luminaire::setPsiRotationAroundXaxis

(

double

psiRotationAroundXaxis

)

bool openstudio::model::Luminaire::setPsiRotationAroundXaxis

(

const Quantity &

psiRotationAroundXaxis

)

bool openstudio::model::Luminaire::setSchedule

(

Schedule &

schedule

)

Sets the (fractional) Schedule.

bool openstudio::model::Luminaire::setThetaRotationAroundYaxis

(

double

thetaRotationAroundYaxis

)

bool openstudio::model::Luminaire::setThetaRotationAroundYaxis

(

const Quantity &

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