src/model/DaylightingDeviceShelf.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_DAYLIGHTINGDEVICESHELF_HPP | ||
| 7 | #define MODEL_DAYLIGHTINGDEVICESHELF_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 DaylightingDeviceShelf_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** DaylightingDeviceShelf is a ModelObject that wraps the OpenStudio IDD object 'OS_DaylightingDevice_Shelf'. */ | ||
| 26 | class MODEL_API DaylightingDeviceShelf : public ModelObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit DaylightingDeviceShelf(const SubSurface& subSurface); | ||
| 33 | |||
| 34 | 128 | virtual ~DaylightingDeviceShelf() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | 40 | DaylightingDeviceShelf(const DaylightingDeviceShelf& other) = default; | |
| 37 | 39 | DaylightingDeviceShelf(DaylightingDeviceShelf&& other) = default; | |
| 38 | ✗ | DaylightingDeviceShelf& operator=(const DaylightingDeviceShelf&) = default; | |
| 39 | ✗ | DaylightingDeviceShelf& operator=(DaylightingDeviceShelf&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | /** @name Static Methods */ | ||
| 43 | //@{ | ||
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | //@} | ||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | boost::optional<InteriorPartitionSurface> insideShelf() const; | ||
| 52 | |||
| 53 | boost::optional<ShadingSurface> outsideShelf() const; | ||
| 54 | |||
| 55 | boost::optional<double> viewFactortoOutsideShelf() const; | ||
| 56 | |||
| 57 | //@} | ||
| 58 | /** @name Setters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | bool setInsideShelf(const InteriorPartitionSurface& insideShelf); | ||
| 62 | |||
| 63 | bool setOutsideShelf(const ShadingSurface& outsideShelf); | ||
| 64 | |||
| 65 | bool setViewFactortoOutsideShelf(double viewFactortoOutsideShelf); | ||
| 66 | |||
| 67 | void resetViewFactortoOutsideShelf(); | ||
| 68 | |||
| 69 | //@} | ||
| 70 | |||
| 71 | /// Get the related sub surface. | ||
| 72 | SubSurface subSurface() const; | ||
| 73 | |||
| 74 | protected: | ||
| 75 | /// @cond | ||
| 76 | using ImplType = detail::DaylightingDeviceShelf_Impl; | ||
| 77 | |||
| 78 | friend class Model; | ||
| 79 | friend class openstudio::IdfObject; | ||
| 80 | friend class openstudio::detail::IdfObject_Impl; | ||
| 81 | |||
| 82 | explicit DaylightingDeviceShelf(std::shared_ptr<detail::DaylightingDeviceShelf_Impl> impl); | ||
| 83 | |||
| 84 | /// @endcond | ||
| 85 | private: | ||
| 86 | − | REGISTER_LOGGER("openstudio.model.DaylightingDeviceShelf"); | |
| 87 | }; | ||
| 88 | |||
| 89 | /** \relates DaylightingDeviceShelf*/ | ||
| 90 | using OptionalDaylightingDeviceShelf = boost::optional<DaylightingDeviceShelf>; | ||
| 91 | |||
| 92 | /** \relates DaylightingDeviceShelf*/ | ||
| 93 | using DaylightingDeviceShelfVector = std::vector<DaylightingDeviceShelf>; | ||
| 94 | |||
| 95 | } // namespace model | ||
| 96 | } // namespace openstudio | ||
| 97 | |||
| 98 | #endif // MODEL_DAYLIGHTINGDEVICESHELF_HPP | ||
| 99 |