ExteriorLights Class Reference

#include "ExteriorLights.hpp"

Inheritance diagram for openstudio::model::ExteriorLights:

Public Member Functions
	ExteriorLights (const ExteriorLightsDefinition &definition, bool useControlOptionAstronomicalClock=false)
	ExteriorLights (const ExteriorLightsDefinition &definition, Schedule &schedule)
virtual	~ExteriorLights ()
ExteriorLightsDefinition	exteriorLightsDefinition () const
boost::optional< Schedule >	schedule () const
std::string	controlOption () const
bool	isControlOptionDefaulted () const
double	multiplier () const
bool	isMultiplierDefaulted () const
std::string	endUseSubcategory () const
bool	isEndUseSubcategoryDefaulted () const
bool	setExteriorLightsDefinition (const ExteriorLightsDefinition &exteriorLightsDefinition)
bool	setSchedule (Schedule &schedule)
void	resetSchedule ()
bool	setControlOption (std::string controlOption)
void	resetControlOption ()
bool	setMultiplier (double multiplier)
void	resetMultiplier ()
bool	setEndUseSubcategory (std::string endUseSubcategory)
void	resetEndUseSubcategory ()
Facility	facility () const

Static Public Member Functions
static std::vector< std::string >	controlOptionValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validControlOptionValues ()

Related Functions
typedef std::vector < ExteriorLights >	ExteriorLightsVector
typedef boost::optional < ExteriorLights >	OptionalExteriorLights

Detailed Description

ExteriorLights is a ExteriorLoadInstance that wraps the OpenStudio IDD object 'OS:Exterior:Lights'.

ExteriorLights is a child of Facility and instances ExteriorLightsDefinition.

Constructor & Destructor Documentation

openstudio::model::ExteriorLights::ExteriorLights	(	const ExteriorLightsDefinition &	definition,
		bool	useControlOptionAstronomicalClock = false
	)

This constructor sets schedule to always on, and provides the option to use the astronomical clock control option.

openstudio::model::ExteriorLights::ExteriorLights	(	const ExteriorLightsDefinition &	definition,
		Schedule &	schedule
	)

This constructor requires a user-specified schedule.

virtual openstudio::model::ExteriorLights::~ExteriorLights ( )

inlinevirtual

Member Function Documentation

std::string openstudio::model::ExteriorLights::controlOption

(

)

const

static std::vector<std::string> openstudio::model::ExteriorLights::controlOptionValues ( )

static

std::string openstudio::model::ExteriorLights::endUseSubcategory

(

)

const

ExteriorLightsDefinition openstudio::model::ExteriorLights::exteriorLightsDefinition

(

)

const

Facility openstudio::model::ExteriorLights::facility

(

)

const

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

static

bool openstudio::model::ExteriorLights::isControlOptionDefaulted

(

)

const

bool openstudio::model::ExteriorLights::isEndUseSubcategoryDefaulted

(

)

const

bool openstudio::model::ExteriorLights::isMultiplierDefaulted

(

)

const

double openstudio::model::ExteriorLights::multiplier

(

)

const

void openstudio::model::ExteriorLights::resetControlOption

(

)

void openstudio::model::ExteriorLights::resetEndUseSubcategory

(

)

void openstudio::model::ExteriorLights::resetMultiplier

(

)

void openstudio::model::ExteriorLights::resetSchedule

(

)

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

(

)

const

bool openstudio::model::ExteriorLights::setControlOption

(

std::string

controlOption

)

bool openstudio::model::ExteriorLights::setEndUseSubcategory

(

std::string

endUseSubcategory

)

bool openstudio::model::ExteriorLights::setExteriorLightsDefinition

(

const ExteriorLightsDefinition &

exteriorLightsDefinition

)

bool openstudio::model::ExteriorLights::setMultiplier

(

double

multiplier

)

bool openstudio::model::ExteriorLights::setSchedule

(

Schedule &

schedule

)

static std::vector<std::string> openstudio::model::ExteriorLights::validControlOptionValues ( )

static

Deprecated:

Friends And Related Function Documentation

typedef std::vector<ExteriorLights> ExteriorLightsVector

related

typedef boost::optional<ExteriorLights> OptionalExteriorLights

related