src/model/DaylightingDeviceLightWell.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_DAYLIGHTINGDEVICELIGHTWELL_HPP | ||
| 7 | #define MODEL_DAYLIGHTINGDEVICELIGHTWELL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class SubSurface; | ||
| 16 | class InteriorPartitionSurface; | ||
| 17 | class ShadingSurface; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class DaylightingDeviceLightWell_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** DaylightingDeviceLightWell is a ModelObject that wraps the OpenStudio IDD object 'OS_DaylightingDevice_LightWell'. */ | ||
| 26 | class MODEL_API DaylightingDeviceLightWell : public ModelObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit DaylightingDeviceLightWell(const SubSurface& subSurface, double heightofWell, double perimeterofBottomofWell, double areaofBottomofWell, | ||
| 33 | double visibleReflectanceofWellWalls); | ||
| 34 | |||
| 35 | explicit DaylightingDeviceLightWell(const SubSurface& subSurface); | ||
| 36 | |||
| 37 | 84 | virtual ~DaylightingDeviceLightWell() override = default; | |
| 38 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 39 | 20 | DaylightingDeviceLightWell(const DaylightingDeviceLightWell& other) = default; | |
| 40 | 29 | DaylightingDeviceLightWell(DaylightingDeviceLightWell&& other) = default; | |
| 41 | ✗ | DaylightingDeviceLightWell& operator=(const DaylightingDeviceLightWell&) = default; | |
| 42 | ✗ | DaylightingDeviceLightWell& operator=(DaylightingDeviceLightWell&&) = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | /** @name Static Methods */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | //@} | ||
| 51 | /** @name Getters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | SubSurface subSurface() const; | ||
| 55 | |||
| 56 | double heightofWell() const; | ||
| 57 | |||
| 58 | double perimeterofBottomofWell() const; | ||
| 59 | |||
| 60 | double areaofBottomofWell() const; | ||
| 61 | |||
| 62 | double visibleReflectanceofWellWalls() const; | ||
| 63 | |||
| 64 | //@} | ||
| 65 | /** @name Setters */ | ||
| 66 | //@{ | ||
| 67 | |||
| 68 | bool setHeightofWell(double heightofWell); | ||
| 69 | |||
| 70 | bool setPerimeterofBottomofWell(double perimeterofBottomofWell); | ||
| 71 | |||
| 72 | bool setAreaofBottomofWell(double areaofBottomofWell); | ||
| 73 | |||
| 74 | bool setVisibleReflectanceofWellWalls(double visibleReflectanceofWellWalls); | ||
| 75 | |||
| 76 | //@} | ||
| 77 | |||
| 78 | protected: | ||
| 79 | /// @cond | ||
| 80 | using ImplType = detail::DaylightingDeviceLightWell_Impl; | ||
| 81 | |||
| 82 | friend class Model; | ||
| 83 | friend class openstudio::IdfObject; | ||
| 84 | friend class openstudio::detail::IdfObject_Impl; | ||
| 85 | |||
| 86 | explicit DaylightingDeviceLightWell(std::shared_ptr<detail::DaylightingDeviceLightWell_Impl> impl); | ||
| 87 | |||
| 88 | /// @endcond | ||
| 89 | private: | ||
| 90 | − | REGISTER_LOGGER("openstudio.model.DaylightingDeviceLightWell"); | |
| 91 | }; | ||
| 92 | |||
| 93 | /** \relates DaylightingDeviceLightWell*/ | ||
| 94 | using OptionalDaylightingDeviceLightWell = boost::optional<DaylightingDeviceLightWell>; | ||
| 95 | |||
| 96 | /** \relates DaylightingDeviceLightWell*/ | ||
| 97 | using DaylightingDeviceLightWellVector = std::vector<DaylightingDeviceLightWell>; | ||
| 98 | |||
| 99 | } // namespace model | ||
| 100 | } // namespace openstudio | ||
| 101 | |||
| 102 | #endif // MODEL_DAYLIGHTINGDEVICELIGHTWELL_HPP | ||
| 103 |