DaylightingControl Class Reference

#include "DaylightingControl.hpp"

Inheritance diagram for openstudio::model::DaylightingControl:

Public Member Functions
bool	aimAt (const Point3d &target)
bool	isPrimaryDaylightingControl () const
bool	isSecondaryDaylightingControl () const
openstudio::Point3d	position () const
bool	setPosition (const openstudio::Point3d &position)
bool	setTransformation (const openstudio::Transformation &transformation)
openstudio::Transformation	transformation () const
	DaylightingControl (const Model &model)
virtual	~DaylightingControl ()
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
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 ()

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

Related Functions
typedef std::vector < DaylightingControl >	DaylightingControlVector
typedef boost::optional < DaylightingControl >	OptionalDaylightingControl

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 ( )

inlinevirtual

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

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

typedef std::vector<DaylightingControl> DaylightingControlVector

related

typedef boost::optional<DaylightingControl> OptionalDaylightingControl

related