src/model/DaylightingDeviceTubular.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_DAYLIGHTINGDEVICETUBULAR_HPP | ||
| 7 | #define MODEL_DAYLIGHTINGDEVICETUBULAR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | #include "ThermalZone.hpp" | ||
| 13 | #include "ThermalZone_Impl.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class SubSurface; | ||
| 19 | class ConstructionBase; | ||
| 20 | class ThermalZone; | ||
| 21 | |||
| 22 | // Note: TransitionZone is a class defined in ThermalZone.hpp so that the order things are exposed to SWIG makes sense | ||
| 23 | class TransitionZone; | ||
| 24 | |||
| 25 | namespace detail { | ||
| 26 | |||
| 27 | class DaylightingDeviceTubular_Impl; | ||
| 28 | |||
| 29 | } // namespace detail | ||
| 30 | |||
| 31 | /** DaylightingDeviceTubular is a ModelObject that wraps the OpenStudio IDD object 'OS_DaylightingDevice_Tubular'. */ | ||
| 32 | class MODEL_API DaylightingDeviceTubular : public ModelObject | ||
| 33 | { | ||
| 34 | public: | ||
| 35 | /** @name Constructors and Destructors */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | explicit DaylightingDeviceTubular(const SubSurface& dome, const SubSurface& diffuser, const ConstructionBase& construction, double diameter, | ||
| 39 | double totalLength, double effectiveThermalResistance); | ||
| 40 | |||
| 41 | explicit DaylightingDeviceTubular(const SubSurface& dome, const SubSurface& diffuser, const ConstructionBase& construction); | ||
| 42 | |||
| 43 | 53 | virtual ~DaylightingDeviceTubular() override = default; | |
| 44 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 45 | 12 | DaylightingDeviceTubular(const DaylightingDeviceTubular& other) = default; | |
| 46 | 17 | DaylightingDeviceTubular(DaylightingDeviceTubular&& other) = default; | |
| 47 | ✗ | DaylightingDeviceTubular& operator=(const DaylightingDeviceTubular&) = default; | |
| 48 | ✗ | DaylightingDeviceTubular& operator=(DaylightingDeviceTubular&&) = default; | |
| 49 | |||
| 50 | //@} | ||
| 51 | /** @name Static Methods */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | static IddObjectType iddObjectType(); | ||
| 55 | |||
| 56 | //@} | ||
| 57 | /** @name Getters */ | ||
| 58 | //@{ | ||
| 59 | |||
| 60 | SubSurface subSurfaceDome() const; | ||
| 61 | |||
| 62 | SubSurface subSurfaceDiffuser() const; | ||
| 63 | |||
| 64 | ConstructionBase construction() const; | ||
| 65 | |||
| 66 | double diameter() const; | ||
| 67 | |||
| 68 | double totalLength() const; | ||
| 69 | |||
| 70 | double effectiveThermalResistance() const; | ||
| 71 | |||
| 72 | std::vector<TransitionZone> transitionZones() const; | ||
| 73 | |||
| 74 | unsigned int numberofTransitionZones() const; | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Setters */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | bool setConstruction(const ConstructionBase& construction); | ||
| 81 | |||
| 82 | bool setDiameter(double diameter); | ||
| 83 | |||
| 84 | bool setTotalLength(double totalLength); | ||
| 85 | |||
| 86 | bool setEffectiveThermalResistance(double effectiveThermalResistance); | ||
| 87 | |||
| 88 | bool addTransitionZone(const TransitionZone& transitionZone); | ||
| 89 | |||
| 90 | bool addTransitionZone(const ThermalZone& zone, double length); | ||
| 91 | |||
| 92 | void removeTransitionZone(int groupIndex); | ||
| 93 | |||
| 94 | void removeAllTransitionZones(); | ||
| 95 | |||
| 96 | bool addTransitionZones(const std::vector<TransitionZone>& transitionZones); | ||
| 97 | |||
| 98 | //@} | ||
| 99 | |||
| 100 | protected: | ||
| 101 | /// @cond | ||
| 102 | using ImplType = detail::DaylightingDeviceTubular_Impl; | ||
| 103 | |||
| 104 | friend class Model; | ||
| 105 | friend class openstudio::IdfObject; | ||
| 106 | friend class openstudio::detail::IdfObject_Impl; | ||
| 107 | |||
| 108 | explicit DaylightingDeviceTubular(std::shared_ptr<detail::DaylightingDeviceTubular_Impl> impl); | ||
| 109 | |||
| 110 | /// @endcond | ||
| 111 | private: | ||
| 112 | − | REGISTER_LOGGER("openstudio.model.DaylightingDeviceTubular"); | |
| 113 | }; | ||
| 114 | |||
| 115 | /** \relates DaylightingDeviceTubular*/ | ||
| 116 | using OptionalDaylightingDeviceTubular = boost::optional<DaylightingDeviceTubular>; | ||
| 117 | |||
| 118 | /** \relates DaylightingDeviceTubular*/ | ||
| 119 | using DaylightingDeviceTubularVector = std::vector<DaylightingDeviceTubular>; | ||
| 120 | |||
| 121 | } // namespace model | ||
| 122 | } // namespace openstudio | ||
| 123 | |||
| 124 | #endif // MODEL_DAYLIGHTINGDEVICETUBULAR_HPP | ||
| 125 |