openstudio::model::DaylightingControl Class Reference

#include <DaylightingControl.hpp>

Inheritance diagram for openstudio::model::DaylightingControl:

Public Member Functions
bool	aimAt (const Point3d &target)
	Keeps current position and orients the view towards the target, target is in space coordinates. More...
bool	isPrimaryDaylightingControl () const
	Is this the primary control point for the containing ThermalZone. More...
bool	isSecondaryDaylightingControl () const
	Is this the secondary control point for the containing ThermalZone. More...
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...
bool	setTransformation (const openstudio::Transformation &transformation)
	Sets a Transformation representing position and orientation 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...
Constructors and Destructors
	DaylightingControl (const Model &model)
virtual	~DaylightingControl ()=default
	DaylightingControl (const DaylightingControl &other)=default
	DaylightingControl (DaylightingControl &&other)=default
DaylightingControl &	operator= (const DaylightingControl &)=default
DaylightingControl &	operator= (DaylightingControl &&)=default
Getters
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	illuminanceSetpoint () const
bool	isIlluminanceSetpointDefaulted () const
std::string	lightingControlType () const
bool	isLightingControlTypeDefaulted () const
double	minimumInputPowerFractionforContinuousDimmingControl () const
bool	isMinimumInputPowerFractionforContinuousDimmingControlDefaulted () const
double	minimumLightOutputFractionforContinuousDimmingControl () const
bool	isMinimumLightOutputFractionforContinuousDimmingControlDefaulted () const
int	numberofSteppedControlSteps () const
bool	isNumberofSteppedControlStepsDefaulted () const
double	probabilityLightingwillbeResetWhenNeededinManualSteppedControl () const
bool	isProbabilityLightingwillbeResetWhenNeededinManualSteppedControlDefaulted () const
int	numberofDaylightingViews () const
bool	isNumberofDaylightingViewsDefaulted () const
boost::optional< double >	maximumAllowableDiscomfortGlareIndex () const
Setters
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	setIlluminanceSetpoint (double illuminanceSetpoint)
void	resetIlluminanceSetpoint ()
bool	setLightingControlType (const std::string &lightingControlType)
void	resetLightingControlType ()
bool	setMinimumInputPowerFractionforContinuousDimmingControl (double minimumInputPowerFractionforContinuousDimmingControl)
void	resetMinimumInputPowerFractionforContinuousDimmingControl ()
bool	setMinimumLightOutputFractionforContinuousDimmingControl (double minimumLightOutputFractionforContinuousDimmingControl)
void	resetMinimumLightOutputFractionforContinuousDimmingControl ()
bool	setNumberofSteppedControlSteps (int numberofSteppedControlSteps)
void	resetNumberofSteppedControlSteps ()
bool	setProbabilityLightingwillbeResetWhenNeededinManualSteppedControl (double probabilityLightingwillbeResetWhenNeededinManualSteppedControl)
void	resetProbabilityLightingwillbeResetWhenNeededinManualSteppedControl ()
bool	setNumberofDaylightingViews (int numberofDaylightingViews)
void	resetNumberofDaylightingViews ()
bool	setMaximumAllowableDiscomfortGlareIndex (double maximumAllowableDiscomfortGlareIndex)
void	resetMaximumAllowableDiscomfortGlareIndex ()
Public Member Functions inherited from openstudio::model::SpaceItem
SpaceItem &	operator= (const SpaceItem &)=default
SpaceItem &	operator= (SpaceItem &&)=default
void	resetSpace ()
bool	setSpace (const Space &space)
	Sets the parent Space. More...
boost::optional< Space >	space () const
	Returns the parent Space. More...
	SpaceItem (const SpaceItem &other)=default
	SpaceItem (SpaceItem &&other)=default
virtual	~SpaceItem ()=default
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
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 (const std::string &valueName, const std::string &units) 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 Methods
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validLightingControlTypeValues ()

Related Functions
(Note that these are not member functions.)
using	DaylightingControlVector = std::vector< DaylightingControl >
using	OptionalDaylightingControl = boost::optional< DaylightingControl >
Related Functions inherited from openstudio::model::SpaceItem
using	OptionalSpaceItem = boost::optional< SpaceItem >
using	SpaceItemVector = std::vector< SpaceItem >
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
using	ImplType = detail::ModelObject_Impl
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

DaylightingControl is a SpaceItem that wraps the OpenStudio IDD object 'OS:Daylighting:Control'.

Constructor & Destructor Documentation

openstudio::model::DaylightingControl::DaylightingControl ( const Model &  model )

explicit

virtual openstudio::model::DaylightingControl::~DaylightingControl ( )

virtualdefault

openstudio::model::DaylightingControl::DaylightingControl ( const DaylightingControl &  other )

default

openstudio::model::DaylightingControl::DaylightingControl ( DaylightingControl &&  other )

default

Member Function Documentation

bool openstudio::model::DaylightingControl::aimAt

(

const Point3d &

target

)

Keeps current position and orients the view towards the target, target is in space coordinates.

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

static

double openstudio::model::DaylightingControl::illuminanceSetpoint

(

)

const

bool openstudio::model::DaylightingControl::isIlluminanceSetpointDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isLightingControlTypeDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isMinimumInputPowerFractionforContinuousDimmingControlDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isMinimumLightOutputFractionforContinuousDimmingControlDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isNumberofDaylightingViewsDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isNumberofSteppedControlStepsDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isPhiRotationAroundZAxisDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isPrimaryDaylightingControl

(

)

const

Is this the primary control point for the containing ThermalZone.

bool openstudio::model::DaylightingControl::isProbabilityLightingwillbeResetWhenNeededinManualSteppedControlDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isPsiRotationAroundXAxisDefaulted

(

)

const

bool openstudio::model::DaylightingControl::isSecondaryDaylightingControl

(

)

const

Is this the secondary control point for the containing ThermalZone.

bool openstudio::model::DaylightingControl::isThetaRotationAroundYAxisDefaulted

(

)

const

std::string openstudio::model::DaylightingControl::lightingControlType

(

)

const

boost::optional<double> openstudio::model::DaylightingControl::maximumAllowableDiscomfortGlareIndex

(

)

const

double openstudio::model::DaylightingControl::minimumInputPowerFractionforContinuousDimmingControl

(

)

const

double openstudio::model::DaylightingControl::minimumLightOutputFractionforContinuousDimmingControl

(

)

const

int openstudio::model::DaylightingControl::numberofDaylightingViews

(

)

const

int openstudio::model::DaylightingControl::numberofSteppedControlSteps

(

)

const

DaylightingControl& openstudio::model::DaylightingControl::operator= ( const DaylightingControl &  )

default

DaylightingControl& openstudio::model::DaylightingControl::operator= ( DaylightingControl &&  )

default

double openstudio::model::DaylightingControl::phiRotationAroundZAxis

(

)

const

openstudio::Point3d openstudio::model::DaylightingControl::position

(

)

const

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

double openstudio::model::DaylightingControl::positionXCoordinate

(

)

const

double openstudio::model::DaylightingControl::positionYCoordinate

(

)

const

double openstudio::model::DaylightingControl::positionZCoordinate

(

)

const

double openstudio::model::DaylightingControl::probabilityLightingwillbeResetWhenNeededinManualSteppedControl

(

)

const

double openstudio::model::DaylightingControl::psiRotationAroundXAxis

(

)

const

void openstudio::model::DaylightingControl::resetIlluminanceSetpoint

(

)

void openstudio::model::DaylightingControl::resetLightingControlType

(

)

void openstudio::model::DaylightingControl::resetMaximumAllowableDiscomfortGlareIndex

(

)

void openstudio::model::DaylightingControl::resetMinimumInputPowerFractionforContinuousDimmingControl

(

)

void openstudio::model::DaylightingControl::resetMinimumLightOutputFractionforContinuousDimmingControl

(

)

void openstudio::model::DaylightingControl::resetNumberofDaylightingViews

(

)

void openstudio::model::DaylightingControl::resetNumberofSteppedControlSteps

(

)

void openstudio::model::DaylightingControl::resetPhiRotationAroundZAxis

(

)

void openstudio::model::DaylightingControl::resetProbabilityLightingwillbeResetWhenNeededinManualSteppedControl

(

)

void openstudio::model::DaylightingControl::resetPsiRotationAroundXAxis

(

)

void openstudio::model::DaylightingControl::resetThetaRotationAroundYAxis

(

)

bool openstudio::model::DaylightingControl::setIlluminanceSetpoint

(

double

illuminanceSetpoint

)

bool openstudio::model::DaylightingControl::setLightingControlType

(

const std::string &

lightingControlType

)

bool openstudio::model::DaylightingControl::setMaximumAllowableDiscomfortGlareIndex

(

double

maximumAllowableDiscomfortGlareIndex

)

bool openstudio::model::DaylightingControl::setMinimumInputPowerFractionforContinuousDimmingControl

(

double

minimumInputPowerFractionforContinuousDimmingControl

)

bool openstudio::model::DaylightingControl::setMinimumLightOutputFractionforContinuousDimmingControl

(

double

minimumLightOutputFractionforContinuousDimmingControl

)

bool openstudio::model::DaylightingControl::setNumberofDaylightingViews

(

int

numberofDaylightingViews

)

bool openstudio::model::DaylightingControl::setNumberofSteppedControlSteps

(

int

numberofSteppedControlSteps

)

bool openstudio::model::DaylightingControl::setPhiRotationAroundZAxis

(

double

phiRotationAroundZAxis

)

bool openstudio::model::DaylightingControl::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 DaylightingControl.

bool openstudio::model::DaylightingControl::setPositionXCoordinate

(

double

positionXCoordinate

)

bool openstudio::model::DaylightingControl::setPositionYCoordinate

(

double

positionYCoordinate

)

bool openstudio::model::DaylightingControl::setPositionZCoordinate

(

double

positionZCoordinate

)

bool openstudio::model::DaylightingControl::setProbabilityLightingwillbeResetWhenNeededinManualSteppedControl

(

double

probabilityLightingwillbeResetWhenNeededinManualSteppedControl

)

bool openstudio::model::DaylightingControl::setPsiRotationAroundXAxis

(

double

psiRotationAroundXAxis

)

bool openstudio::model::DaylightingControl::setThetaRotationAroundYAxis

(

double

thetaRotationAroundYAxis

)

bool openstudio::model::DaylightingControl::setTransformation

(

const openstudio::Transformation &

transformation

)

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

double openstudio::model::DaylightingControl::thetaRotationAroundYAxis

(

)

const

openstudio::Transformation openstudio::model::DaylightingControl::transformation

(

)

const

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

static std::vector<std::string> openstudio::model::DaylightingControl::validLightingControlTypeValues ( )

static

Friends And Related Function Documentation

using DaylightingControlVector = std::vector<DaylightingControl>

related

using OptionalDaylightingControl = boost::optional<DaylightingControl>

related