src/model/IlluminanceMap_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_ILLUMINANCEMAP_IMPL_HPP | ||
| 7 | #define MODEL_ILLUMINANCEMAP_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 IlluminanceMap; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** IlluminanceMap_Impl is a SpaceItem_Impl that is the implementation class for IlluminanceMap.*/ | ||
| 24 | class MODEL_API IlluminanceMap_Impl : public SpaceItem_Impl | ||
| 25 | { | ||
| 26 | |||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | IlluminanceMap_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | IlluminanceMap_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | IlluminanceMap_Impl(const IlluminanceMap_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | 304 | virtual ~IlluminanceMap_Impl() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | // Get all output variable names that could be associated with this object. | ||
| 42 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 43 | |||
| 44 | virtual IddObjectType iddObjectType() const override; | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | double originXCoordinate() const; | ||
| 50 | |||
| 51 | double originYCoordinate() const; | ||
| 52 | |||
| 53 | double originZCoordinate() const; | ||
| 54 | |||
| 55 | double psiRotationAroundXAxis() const; | ||
| 56 | |||
| 57 | bool isPsiRotationAroundXAxisDefaulted() const; | ||
| 58 | |||
| 59 | double thetaRotationAroundYAxis() const; | ||
| 60 | |||
| 61 | bool isThetaRotationAroundYAxisDefaulted() const; | ||
| 62 | |||
| 63 | double phiRotationAroundZAxis() const; | ||
| 64 | |||
| 65 | bool isPhiRotationAroundZAxisDefaulted() const; | ||
| 66 | |||
| 67 | double xLength() const; | ||
| 68 | |||
| 69 | bool isXLengthDefaulted() const; | ||
| 70 | |||
| 71 | int numberofXGridPoints() const; | ||
| 72 | |||
| 73 | bool isNumberofXGridPointsDefaulted() const; | ||
| 74 | |||
| 75 | double yLength() const; | ||
| 76 | |||
| 77 | bool isYLengthDefaulted() const; | ||
| 78 | |||
| 79 | int numberofYGridPoints() const; | ||
| 80 | |||
| 81 | bool isNumberofYGridPointsDefaulted() const; | ||
| 82 | |||
| 83 | //@} | ||
| 84 | /** @name Setters */ | ||
| 85 | //@{ | ||
| 86 | |||
| 87 | bool setOriginXCoordinate(double originXCoordinate); | ||
| 88 | |||
| 89 | bool setOriginYCoordinate(double originYCoordinate); | ||
| 90 | |||
| 91 | bool setOriginZCoordinate(double originZCoordinate); | ||
| 92 | |||
| 93 | bool setPsiRotationAroundXAxis(double psiRotationAroundXAxis); | ||
| 94 | |||
| 95 | void resetPsiRotationAroundXAxis(); | ||
| 96 | |||
| 97 | bool setThetaRotationAroundYAxis(double thetaRotationAroundYAxis); | ||
| 98 | |||
| 99 | void resetThetaRotationAroundYAxis(); | ||
| 100 | |||
| 101 | bool setPhiRotationAroundZAxis(double phiRotationAroundZAxis); | ||
| 102 | |||
| 103 | void resetPhiRotationAroundZAxis(); | ||
| 104 | |||
| 105 | bool setXLength(double xLength); | ||
| 106 | |||
| 107 | void resetXLength(); | ||
| 108 | |||
| 109 | bool setNumberofXGridPoints(int numberofXGridPoints); | ||
| 110 | |||
| 111 | void resetNumberofXGridPoints(); | ||
| 112 | |||
| 113 | bool setYLength(double yLength); | ||
| 114 | |||
| 115 | void resetYLength(); | ||
| 116 | |||
| 117 | bool setNumberofYGridPoints(int numberofYGridPoints); | ||
| 118 | |||
| 119 | void resetNumberofYGridPoints(); | ||
| 120 | |||
| 121 | //@} | ||
| 122 | |||
| 123 | openstudio::Transformation transformation() const; | ||
| 124 | |||
| 125 | bool setTransformation(const openstudio::Transformation& transformation); | ||
| 126 | |||
| 127 | std::vector<Point3d> referencePoints() const; | ||
| 128 | |||
| 129 | std::vector<Point3d> corners() const; | ||
| 130 | |||
| 131 | protected: | ||
| 132 | // index of the space name | ||
| 133 | virtual int spaceIndex() const override; | ||
| 134 | |||
| 135 | private: | ||
| 136 | REGISTER_LOGGER("openstudio.model.IlluminanceMap"); | ||
| 137 | }; | ||
| 138 | |||
| 139 | } // namespace detail | ||
| 140 | |||
| 141 | } // namespace model | ||
| 142 | } // namespace openstudio | ||
| 143 | |||
| 144 | #endif // MODEL_ILLUMINANCEMAP_IMPL_HPP | ||
| 145 |