src/model/GlareSensor_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_GLARESENSOR_IMPL_HPP | ||
| 7 | #define MODEL_GLARESENSOR_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 GlareSensor; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** GlareSensor_Impl is a SpaceItem_Impl that is the implementation class for GlareSensor.*/ | ||
| 24 | class MODEL_API GlareSensor_Impl : public SpaceItem_Impl | ||
| 25 | { | ||
| 26 | |||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | GlareSensor_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | GlareSensor_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | GlareSensor_Impl(const GlareSensor_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | 283 | virtual ~GlareSensor_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 | int numberofGlareViewVectors() const; | ||
| 67 | |||
| 68 | bool isNumberofGlareViewVectorsDefaulted() const; | ||
| 69 | |||
| 70 | boost::optional<double> maximumAllowableDaylightGlareProbability() const; | ||
| 71 | |||
| 72 | bool isMaximumAllowableDaylightGlareProbabilityDefaulted() const; | ||
| 73 | |||
| 74 | //@} | ||
| 75 | /** @name Setters */ | ||
| 76 | //@{ | ||
| 77 | |||
| 78 | bool setPositionXCoordinate(double positionXCoordinate); | ||
| 79 | |||
| 80 | bool setPositionYCoordinate(double positionYCoordinate); | ||
| 81 | |||
| 82 | bool setPositionZCoordinate(double positionZCoordinate); | ||
| 83 | |||
| 84 | bool setPsiRotationAroundXAxis(double psiRotationAroundXAxis); | ||
| 85 | |||
| 86 | void resetPsiRotationAroundXAxis(); | ||
| 87 | |||
| 88 | bool setThetaRotationAroundYAxis(double thetaRotationAroundYAxis); | ||
| 89 | |||
| 90 | void resetThetaRotationAroundYAxis(); | ||
| 91 | |||
| 92 | bool setPhiRotationAroundZAxis(double phiRotationAroundZAxis); | ||
| 93 | |||
| 94 | void resetPhiRotationAroundZAxis(); | ||
| 95 | |||
| 96 | bool setNumberofGlareViewVectors(int numberofGlareViewVectors); | ||
| 97 | |||
| 98 | void resetNumberofGlareViewVectors(); | ||
| 99 | |||
| 100 | bool setMaximumAllowableDaylightGlareProbability(boost::optional<double> maximumAllowableDaylightGlareProbability); | ||
| 101 | |||
| 102 | void resetMaximumAllowableDaylightGlareProbability(); | ||
| 103 | |||
| 104 | //@} | ||
| 105 | |||
| 106 | openstudio::Point3d position() const; | ||
| 107 | |||
| 108 | bool setPosition(const openstudio::Point3d& position); | ||
| 109 | |||
| 110 | openstudio::Transformation transformation() const; | ||
| 111 | |||
| 112 | bool setTransformation(const openstudio::Transformation& transformation); | ||
| 113 | |||
| 114 | bool aimAt(const Point3d& target); | ||
| 115 | |||
| 116 | protected: | ||
| 117 | // index of the space name | ||
| 118 | virtual int spaceIndex() const override; | ||
| 119 | |||
| 120 | private: | ||
| 121 | REGISTER_LOGGER("openstudio.model.GlareSensor"); | ||
| 122 | }; | ||
| 123 | |||
| 124 | } // namespace detail | ||
| 125 | |||
| 126 | } // namespace model | ||
| 127 | } // namespace openstudio | ||
| 128 | |||
| 129 | #endif // MODEL_GLARESENSOR_IMPL_HPP | ||
| 130 |