src/model/DaylightingControl_Impl.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #ifndef MODEL_DAYLIGHTINGCONTROL_IMPL_HPP | ||
| 7 | #define MODEL_DAYLIGHTINGCONTROL_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SpaceItem_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | class Point3d; | ||
| 15 | class Transformation; | ||
| 16 | |||
| 17 | namespace model { | ||
| 18 | |||
| 19 | class DaylightingControl; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** DaylightingControl_Impl is a SpaceItem_Impl that is the implementation class for DaylightingControl.*/ | ||
| 24 | class MODEL_API DaylightingControl_Impl : public SpaceItem_Impl | ||
| 25 | { | ||
| 26 | |||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | DaylightingControl_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | DaylightingControl_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | DaylightingControl_Impl(const DaylightingControl_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | 388 | virtual ~DaylightingControl_Impl() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | /** @name Getters */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | double positionXCoordinate() const; | ||
| 49 | |||
| 50 | double positionYCoordinate() const; | ||
| 51 | |||
| 52 | double positionZCoordinate() const; | ||
| 53 | |||
| 54 | double psiRotationAroundXAxis() const; | ||
| 55 | |||
| 56 | bool isPsiRotationAroundXAxisDefaulted() const; | ||
| 57 | |||
| 58 | double thetaRotationAroundYAxis() const; | ||
| 59 | |||
| 60 | bool isThetaRotationAroundYAxisDefaulted() const; | ||
| 61 | |||
| 62 | double phiRotationAroundZAxis() const; | ||
| 63 | |||
| 64 | bool isPhiRotationAroundZAxisDefaulted() const; | ||
| 65 | |||
| 66 | double illuminanceSetpoint() const; | ||
| 67 | |||
| 68 | bool isIlluminanceSetpointDefaulted() const; | ||
| 69 | |||
| 70 | std::string lightingControlType() const; | ||
| 71 | |||
| 72 | bool isLightingControlTypeDefaulted() const; | ||
| 73 | |||
| 74 | double minimumInputPowerFractionforContinuousDimmingControl() const; | ||
| 75 | |||
| 76 | bool isMinimumInputPowerFractionforContinuousDimmingControlDefaulted() const; | ||
| 77 | |||
| 78 | double minimumLightOutputFractionforContinuousDimmingControl() const; | ||
| 79 | |||
| 80 | bool isMinimumLightOutputFractionforContinuousDimmingControlDefaulted() const; | ||
| 81 | |||
| 82 | int numberofSteppedControlSteps() const; | ||
| 83 | |||
| 84 | bool isNumberofSteppedControlStepsDefaulted() const; | ||
| 85 | |||
| 86 | double probabilityLightingwillbeResetWhenNeededinManualSteppedControl() const; | ||
| 87 | |||
| 88 | bool isProbabilityLightingwillbeResetWhenNeededinManualSteppedControlDefaulted() const; | ||
| 89 | |||
| 90 | int numberofDaylightingViews() const; | ||
| 91 | |||
| 92 | bool isNumberofDaylightingViewsDefaulted() const; | ||
| 93 | |||
| 94 | boost::optional<double> maximumAllowableDiscomfortGlareIndex() const; | ||
| 95 | |||
| 96 | //@} | ||
| 97 | /** @name Setters */ | ||
| 98 | //@{ | ||
| 99 | |||
| 100 | bool setPositionXCoordinate(double positionXCoordinate); | ||
| 101 | |||
| 102 | bool setPositionYCoordinate(double positionYCoordinate); | ||
| 103 | |||
| 104 | bool setPositionZCoordinate(double positionZCoordinate); | ||
| 105 | |||
| 106 | bool setPsiRotationAroundXAxis(double psiRotationAroundXAxis); | ||
| 107 | |||
| 108 | void resetPsiRotationAroundXAxis(); | ||
| 109 | |||
| 110 | bool setThetaRotationAroundYAxis(double thetaRotationAroundYAxis); | ||
| 111 | |||
| 112 | void resetThetaRotationAroundYAxis(); | ||
| 113 | |||
| 114 | bool setPhiRotationAroundZAxis(double phiRotationAroundZAxis); | ||
| 115 | |||
| 116 | void resetPhiRotationAroundZAxis(); | ||
| 117 | |||
| 118 | bool setIlluminanceSetpoint(double illuminanceSetpoint); | ||
| 119 | |||
| 120 | void resetIlluminanceSetpoint(); | ||
| 121 | |||
| 122 | bool setLightingControlType(const std::string& lightingControlType); | ||
| 123 | |||
| 124 | void resetLightingControlType(); | ||
| 125 | |||
| 126 | bool setMinimumInputPowerFractionforContinuousDimmingControl(double minimumInputPowerFractionforContinuousDimmingControl); | ||
| 127 | |||
| 128 | void resetMinimumInputPowerFractionforContinuousDimmingControl(); | ||
| 129 | |||
| 130 | bool setMinimumLightOutputFractionforContinuousDimmingControl(double minimumLightOutputFractionforContinuousDimmingControl); | ||
| 131 | |||
| 132 | void resetMinimumLightOutputFractionforContinuousDimmingControl(); | ||
| 133 | |||
| 134 | bool setNumberofSteppedControlSteps(int numberofSteppedControlSteps); | ||
| 135 | |||
| 136 | void resetNumberofSteppedControlSteps(); | ||
| 137 | |||
| 138 | bool setProbabilityLightingwillbeResetWhenNeededinManualSteppedControl(double probabilityLightingwillbeResetWhenNeededinManualSteppedControl); | ||
| 139 | |||
| 140 | void resetProbabilityLightingwillbeResetWhenNeededinManualSteppedControl(); | ||
| 141 | |||
| 142 | bool setNumberofDaylightingViews(int numberofDaylightingViews); | ||
| 143 | |||
| 144 | void resetNumberofDaylightingViews(); | ||
| 145 | |||
| 146 | bool setMaximumAllowableDiscomfortGlareIndex(boost::optional<double> maximumAllowableDiscomfortGlareIndex); | ||
| 147 | |||
| 148 | void resetMaximumAllowableDiscomfortGlareIndex(); | ||
| 149 | |||
| 150 | //@} | ||
| 151 | |||
| 152 | openstudio::Point3d position() const; | ||
| 153 | |||
| 154 | bool setPosition(const openstudio::Point3d& position); | ||
| 155 | |||
| 156 | openstudio::Transformation transformation() const; | ||
| 157 | |||
| 158 | bool setTransformation(const openstudio::Transformation& transformation); | ||
| 159 | |||
| 160 | bool isPrimaryDaylightingControl() const; | ||
| 161 | |||
| 162 | bool isSecondaryDaylightingControl() const; | ||
| 163 | |||
| 164 | bool aimAt(const Point3d& target); | ||
| 165 | |||
| 166 | protected: | ||
| 167 | // index of the space name | ||
| 168 | virtual int spaceIndex() const override; | ||
| 169 | |||
| 170 | private: | ||
| 171 | REGISTER_LOGGER("openstudio.model.DaylightingControl"); | ||
| 172 | }; | ||
| 173 | |||
| 174 | } // namespace detail | ||
| 175 | |||
| 176 | } // namespace model | ||
| 177 | } // namespace openstudio | ||
| 178 | |||
| 179 | #endif // MODEL_DAYLIGHTINGCONTROL_IMPL_HPP | ||
| 180 |