Lights Class Reference

#include "Lights.hpp"

Inheritance diagram for openstudio::model::Lights:

Public Member Functions
	Lights (const LightsDefinition &lightsDefinition)
virtual	~Lights ()
LightsDefinition	lightsDefinition () const
boost::optional< Schedule >	schedule () const
bool	isScheduleDefaulted () const
double	fractionReplaceable () const
bool	isFractionReplaceableDefaulted () const
std::string	endUseSubcategory () const
bool	isEndUseSubcategoryDefaulted () const
bool	setLightsDefinition (const LightsDefinition &definition)
bool	setSchedule (Schedule &schedule)
void	resetSchedule ()
bool	setFractionReplaceable (double fractionReplaceable)
void	resetFractionReplaceable ()
bool	setMultiplier (double multiplier)
void	resetMultiplier ()
void	setEndUseSubcategory (std::string endUseSubcategory)
void	resetEndUseSubcategory ()
boost::optional< double >	lightingLevel () const
boost::optional< double >	powerPerFloorArea () const
boost::optional< double >	powerPerPerson () const
double	getLightingPower (double floorArea, double numPeople) const
double	getPowerPerFloorArea (double floorArea, double numPeople) const
double	getPowerPerPerson (double floorArea, double numPeople) const

Static Public Member Functions
static IddObjectType	iddObjectType ()

Related Functions
typedef std::vector< Lights >	LightsVector
typedef boost::optional< Lights >	OptionalLights

Detailed Description

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

See also

LightsDefinition

Constructor & Destructor Documentation

openstudio::model::Lights::Lights ( const LightsDefinition &  lightsDefinition )

explicit

virtual openstudio::model::Lights::~Lights ( )

inlinevirtual

Member Function Documentation

std::string openstudio::model::Lights::endUseSubcategory

(

)

const

double openstudio::model::Lights::fractionReplaceable

(

)

const

double openstudio::model::Lights::getLightingPower	(	double	floorArea,
		double	numPeople
	)		const

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

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

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

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

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

static IddObjectType openstudio::model::Lights::iddObjectType ( )

static

bool openstudio::model::Lights::isEndUseSubcategoryDefaulted

(

)

const

bool openstudio::model::Lights::isFractionReplaceableDefaulted

(

)

const

bool openstudio::model::Lights::isScheduleDefaulted

(

)

const

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

boost::optional<double> openstudio::model::Lights::lightingLevel

(

)

const

Returns the lightingLevel if possible based on the underlying data of lightsDefinition().

LightsDefinition openstudio::model::Lights::lightsDefinition

(

)

const

Gets the LightsDefinition object.

boost::optional<double> openstudio::model::Lights::powerPerFloorArea

(

)

const

Returns the powerPerFloorArea if possible based on the underlying data of lightsDefinition().

boost::optional<double> openstudio::model::Lights::powerPerPerson

(

)

const

Returns the powerPerPerson if possible based on the underlying data of lightsDefinition().

void openstudio::model::Lights::resetEndUseSubcategory

(

)

void openstudio::model::Lights::resetFractionReplaceable

(

)

void openstudio::model::Lights::resetMultiplier

(

)

void openstudio::model::Lights::resetSchedule

(

)

Resets the (fractional) Schedule.

boost::optional<Schedule> openstudio::model::Lights::schedule

(

)

const

Returns the (fractional) lighting schedule.

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

void openstudio::model::Lights::setEndUseSubcategory

(

std::string

endUseSubcategory

)

bool openstudio::model::Lights::setFractionReplaceable

(

double

fractionReplaceable

)

bool openstudio::model::Lights::setLightsDefinition

(

const LightsDefinition &

definition

)

Sets the LightsDefinition object.

bool openstudio::model::Lights::setMultiplier

(

double

multiplier

)

bool openstudio::model::Lights::setSchedule

(

Schedule &

schedule

)

Sets the (fractional) Schedule.

Friends And Related Function Documentation

typedef std::vector<Lights> LightsVector

related

typedef boost::optional<Lights> OptionalLights

related