src/model/LightingSimulationZone.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_LIGHTINGSIMULATIONZONE_HPP | ||
| 7 | #define MODEL_LIGHTINGSIMULATIONZONE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class RenderingColor; | ||
| 16 | class Space; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class LightingSimulationZone_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | // ETH@20120328 Should LightingSimulationZone be parented by Building, | ||
| 25 | // similar to ThermalZone? | ||
| 26 | |||
| 27 | /** LightingSimulationZone is a ModelObject that wraps the OpenStudio IDD object 'OS_LightingSimulationZone'. */ | ||
| 28 | class MODEL_API LightingSimulationZone : public ModelObject | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit LightingSimulationZone(const Model& model); | ||
| 35 | |||
| 36 | 1 | virtual ~LightingSimulationZone() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | ✗ | LightingSimulationZone(const LightingSimulationZone& other) = default; | |
| 39 | ✗ | LightingSimulationZone(LightingSimulationZone&& other) = default; | |
| 40 | ✗ | LightingSimulationZone& operator=(const LightingSimulationZone&) = default; | |
| 41 | ✗ | LightingSimulationZone& operator=(LightingSimulationZone&&) = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | /** @name Static Methods */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | static IddObjectType iddObjectType(); | ||
| 48 | |||
| 49 | //@} | ||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | //@} | ||
| 54 | /** @name Setters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | //@} | ||
| 58 | |||
| 59 | /// Returns the rendering color. | ||
| 60 | boost::optional<RenderingColor> renderingColor() const; | ||
| 61 | |||
| 62 | /// Sets the rendering color. | ||
| 63 | bool setRenderingColor(const RenderingColor& renderingColor); | ||
| 64 | |||
| 65 | /// Resets the rendering color. | ||
| 66 | void resetRenderingColor(); | ||
| 67 | |||
| 68 | /// Returns all spaces in this lighting simulation zone. | ||
| 69 | std::vector<Space> spaces() const; | ||
| 70 | |||
| 71 | /// Adds a spaces to this lighting simulation zone. | ||
| 72 | bool addSpace(const Space& space); | ||
| 73 | |||
| 74 | /// Resets spaces in this lighting simulation zone. | ||
| 75 | void resetSpaces(); | ||
| 76 | |||
| 77 | protected: | ||
| 78 | /// @cond | ||
| 79 | using ImplType = detail::LightingSimulationZone_Impl; | ||
| 80 | |||
| 81 | friend class Model; | ||
| 82 | friend class openstudio::IdfObject; | ||
| 83 | |||
| 84 | explicit LightingSimulationZone(std::shared_ptr<detail::LightingSimulationZone_Impl> impl); | ||
| 85 | |||
| 86 | /// @endcond | ||
| 87 | private: | ||
| 88 | REGISTER_LOGGER("openstudio.model.LightingSimulationZone"); | ||
| 89 | }; | ||
| 90 | |||
| 91 | /** \relates LightingSimulationZone*/ | ||
| 92 | using OptionalLightingSimulationZone = boost::optional<LightingSimulationZone>; | ||
| 93 | |||
| 94 | /** \relates LightingSimulationZone*/ | ||
| 95 | using LightingSimulationZoneVector = std::vector<LightingSimulationZone>; | ||
| 96 | |||
| 97 | } // namespace model | ||
| 98 | } // namespace openstudio | ||
| 99 | |||
| 100 | #endif // MODEL_LIGHTINGSIMULATIONZONE_HPP | ||
| 101 |