#include <Lights.hpp>

Inheritance diagram for openstudio::model::Lights:

Public Member Functions
Constructors and Destructors
	Lights (const LightsDefinition &lightsDefinition)

virtual	~Lights ()

Getters
LightsDefinition	lightsDefinition () const
	Gets the LightsDefinition object. More...

boost::optional< Schedule >	schedule () const
	Returns the (fractional) lighting schedule. More...

bool	isScheduleDefaulted () const
	Returns true if this object does not specify a schedule directly. More...

double	fractionReplaceable () const

bool	isFractionReplaceableDefaulted () const

std::string	endUseSubcategory () const

bool	isEndUseSubcategoryDefaulted () const

Setters
bool	setLightsDefinition (const LightsDefinition &definition)
	Sets the LightsDefinition object. More...

bool	setSchedule (Schedule &schedule)
	Sets the (fractional) Schedule. More...

void	resetSchedule ()
	Resets the (fractional) Schedule. More...

bool	setFractionReplaceable (double fractionReplaceable)

void	resetFractionReplaceable ()

bool	setMultiplier (double multiplier)

void	resetMultiplier ()

bool	setEndUseSubcategory (std::string endUseSubcategory)

void	resetEndUseSubcategory ()

Other
boost::optional< double >	lightingLevel () const
	Returns the lightingLevel if possible based on the underlying data of lightsDefinition(). More...

boost::optional< double >	powerPerFloorArea () const
	Returns the powerPerFloorArea if possible based on the underlying data of lightsDefinition(). More...

boost::optional< double >	powerPerPerson () const
	Returns the powerPerPerson if possible based on the underlying data of lightsDefinition(). More...

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

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

double	getPowerPerPerson (double floorArea, double numPeople) const
	Returns the watts/person represented by this instance, assuming floorArea (m^2) and 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< SpaceType >	spaceType () 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< Space >	space () 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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...

std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () 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< LifeCycleCost >	lifeCycleCosts () 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< ScheduleTypeKey >	getScheduleTypeKeys (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< ModelObject >	connectedObject (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< Lights >	LightsVector

typedef boost::optional< Lights >	OptionalLights

Related Functions inherited from openstudio::model::SpaceLoadInstance
typedef boost::optional < SpaceLoadInstance >	OptionalSpaceLoadInstance

typedef std::vector < SpaceLoadInstance >	SpaceLoadInstanceVector

Related Functions inherited from openstudio::model::SpaceLoad
typedef boost::optional < SpaceLoad >	OptionalSpaceLoad

typedef std::vector< SpaceLoad >	SpaceLoadVector

Related Functions inherited from openstudio::model::SpaceItem
typedef boost::optional < SpaceItem >	OptionalSpaceItem

typedef std::vector< SpaceItem >	SpaceItemVector

Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

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

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.

bool 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

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation