src/model/WindowPropertyFrameAndDivider.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_WINDOWPROPERTYFRAMEANDDIVIDER_HPP | ||
| 7 | #define MODEL_WINDOWPROPERTYFRAMEANDDIVIDER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ResourceObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class WindowPropertyFrameAndDivider_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** WindowPropertyFrameAndDivider is a ResourceObject that wraps the OpenStudio IDD object 'OS:WindowProperty:FrameAndDivider'. */ | ||
| 23 | class MODEL_API WindowPropertyFrameAndDivider : public ResourceObject | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit WindowPropertyFrameAndDivider(const Model& model); | ||
| 30 | |||
| 31 | 201 | virtual ~WindowPropertyFrameAndDivider() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | 5 | WindowPropertyFrameAndDivider(const WindowPropertyFrameAndDivider& other) = default; | |
| 34 | 88 | WindowPropertyFrameAndDivider(WindowPropertyFrameAndDivider&& other) = default; | |
| 35 | ✗ | WindowPropertyFrameAndDivider& operator=(const WindowPropertyFrameAndDivider&) = default; | |
| 36 | ✗ | WindowPropertyFrameAndDivider& operator=(WindowPropertyFrameAndDivider&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | static std::vector<std::string> dividerTypeValues(); | ||
| 43 | |||
| 44 | /** @name Getters */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | double frameWidth() const; | ||
| 48 | |||
| 49 | bool isFrameWidthDefaulted() const; | ||
| 50 | |||
| 51 | double frameOutsideProjection() const; | ||
| 52 | |||
| 53 | bool isFrameOutsideProjectionDefaulted() const; | ||
| 54 | |||
| 55 | double frameInsideProjection() const; | ||
| 56 | |||
| 57 | bool isFrameInsideProjectionDefaulted() const; | ||
| 58 | |||
| 59 | double frameConductance() const; | ||
| 60 | |||
| 61 | bool isFrameConductanceDefaulted() const; | ||
| 62 | |||
| 63 | double ratioOfFrameEdgeGlassConductanceToCenterOfGlassConductance() const; | ||
| 64 | |||
| 65 | bool isRatioOfFrameEdgeGlassConductanceToCenterOfGlassConductanceDefaulted() const; | ||
| 66 | |||
| 67 | double frameSolarAbsorptance() const; | ||
| 68 | |||
| 69 | bool isFrameSolarAbsorptanceDefaulted() const; | ||
| 70 | |||
| 71 | double frameVisibleAbsorptance() const; | ||
| 72 | |||
| 73 | bool isFrameVisibleAbsorptanceDefaulted() const; | ||
| 74 | |||
| 75 | double frameThermalHemisphericalEmissivity() const; | ||
| 76 | |||
| 77 | bool isFrameThermalHemisphericalEmissivityDefaulted() const; | ||
| 78 | |||
| 79 | std::string dividerType() const; | ||
| 80 | |||
| 81 | bool isDividerTypeDefaulted() const; | ||
| 82 | |||
| 83 | double dividerWidth() const; | ||
| 84 | |||
| 85 | bool isDividerWidthDefaulted() const; | ||
| 86 | |||
| 87 | int numberOfHorizontalDividers() const; | ||
| 88 | |||
| 89 | bool isNumberOfHorizontalDividersDefaulted() const; | ||
| 90 | |||
| 91 | int numberOfVerticalDividers() const; | ||
| 92 | |||
| 93 | bool isNumberOfVerticalDividersDefaulted() const; | ||
| 94 | |||
| 95 | double dividerOutsideProjection() const; | ||
| 96 | |||
| 97 | bool isDividerOutsideProjectionDefaulted() const; | ||
| 98 | |||
| 99 | double dividerInsideProjection() const; | ||
| 100 | |||
| 101 | bool isDividerInsideProjectionDefaulted() const; | ||
| 102 | |||
| 103 | double dividerConductance() const; | ||
| 104 | |||
| 105 | bool isDividerConductanceDefaulted() const; | ||
| 106 | |||
| 107 | double ratioOfDividerEdgeGlassConductanceToCenterOfGlassConductance() const; | ||
| 108 | |||
| 109 | bool isRatioOfDividerEdgeGlassConductanceToCenterOfGlassConductanceDefaulted() const; | ||
| 110 | |||
| 111 | double dividerSolarAbsorptance() const; | ||
| 112 | |||
| 113 | bool isDividerSolarAbsorptanceDefaulted() const; | ||
| 114 | |||
| 115 | double dividerVisibleAbsorptance() const; | ||
| 116 | |||
| 117 | bool isDividerVisibleAbsorptanceDefaulted() const; | ||
| 118 | |||
| 119 | double dividerThermalHemisphericalEmissivity() const; | ||
| 120 | |||
| 121 | bool isDividerThermalHemisphericalEmissivityDefaulted() const; | ||
| 122 | |||
| 123 | double outsideRevealDepth() const; | ||
| 124 | |||
| 125 | bool isOutsideRevealDepthDefaulted() const; | ||
| 126 | |||
| 127 | double outsideRevealSolarAbsorptance() const; | ||
| 128 | |||
| 129 | bool isOutsideRevealSolarAbsorptanceDefaulted() const; | ||
| 130 | |||
| 131 | double insideSillDepth() const; | ||
| 132 | |||
| 133 | bool isInsideSillDepthDefaulted() const; | ||
| 134 | |||
| 135 | double insideSillSolarAbsorptance() const; | ||
| 136 | |||
| 137 | bool isInsideSillSolarAbsorptanceDefaulted() const; | ||
| 138 | |||
| 139 | double insideRevealDepth() const; | ||
| 140 | |||
| 141 | bool isInsideRevealDepthDefaulted() const; | ||
| 142 | |||
| 143 | double insideRevealSolarAbsorptance() const; | ||
| 144 | |||
| 145 | bool isInsideRevealSolarAbsorptanceDefaulted() const; | ||
| 146 | |||
| 147 | std::string nfrcProductTypeforAssemblyCalculations() const; | ||
| 148 | |||
| 149 | bool isNFRCProductTypeforAssemblyCalculationsDefaulted() const; | ||
| 150 | |||
| 151 | //@} | ||
| 152 | /** @name Setters */ | ||
| 153 | //@{ | ||
| 154 | |||
| 155 | bool setFrameWidth(double frameWidth); | ||
| 156 | |||
| 157 | void resetFrameWidth(); | ||
| 158 | |||
| 159 | bool setFrameOutsideProjection(double frameOutsideProjection); | ||
| 160 | |||
| 161 | void resetFrameOutsideProjection(); | ||
| 162 | |||
| 163 | bool setFrameInsideProjection(double frameInsideProjection); | ||
| 164 | |||
| 165 | void resetFrameInsideProjection(); | ||
| 166 | |||
| 167 | bool setFrameConductance(double frameConductance); | ||
| 168 | |||
| 169 | void resetFrameConductance(); | ||
| 170 | |||
| 171 | bool setRatioOfFrameEdgeGlassConductanceToCenterOfGlassConductance(double ratioOfFrameEdgeGlassConductanceToCenterOfGlassConductance); | ||
| 172 | |||
| 173 | void resetRatioOfFrameEdgeGlassConductanceToCenterOfGlassConductance(); | ||
| 174 | |||
| 175 | bool setFrameSolarAbsorptance(double frameSolarAbsorptance); | ||
| 176 | |||
| 177 | void resetFrameSolarAbsorptance(); | ||
| 178 | |||
| 179 | bool setFrameVisibleAbsorptance(double frameVisibleAbsorptance); | ||
| 180 | |||
| 181 | void resetFrameVisibleAbsorptance(); | ||
| 182 | |||
| 183 | bool setFrameThermalHemisphericalEmissivity(double frameThermalHemisphericalEmissivity); | ||
| 184 | |||
| 185 | void resetFrameThermalHemisphericalEmissivity(); | ||
| 186 | |||
| 187 | bool setDividerType(const std::string& dividerType); | ||
| 188 | |||
| 189 | void resetDividerType(); | ||
| 190 | |||
| 191 | bool setDividerWidth(double dividerWidth); | ||
| 192 | |||
| 193 | void resetDividerWidth(); | ||
| 194 | |||
| 195 | bool setNumberOfHorizontalDividers(int numberOfHorizontalDividers); | ||
| 196 | |||
| 197 | void resetNumberOfHorizontalDividers(); | ||
| 198 | |||
| 199 | bool setNumberOfVerticalDividers(int numberOfVerticalDividers); | ||
| 200 | |||
| 201 | void resetNumberOfVerticalDividers(); | ||
| 202 | |||
| 203 | bool setDividerOutsideProjection(double dividerOutsideProjection); | ||
| 204 | |||
| 205 | void resetDividerOutsideProjection(); | ||
| 206 | |||
| 207 | bool setDividerInsideProjection(double dividerInsideProjection); | ||
| 208 | |||
| 209 | void resetDividerInsideProjection(); | ||
| 210 | |||
| 211 | bool setDividerConductance(double dividerConductance); | ||
| 212 | |||
| 213 | void resetDividerConductance(); | ||
| 214 | |||
| 215 | bool setRatioOfDividerEdgeGlassConductanceToCenterOfGlassConductance(double ratioOfDividerEdgeGlassConductanceToCenterOfGlassConductance); | ||
| 216 | |||
| 217 | void resetRatioOfDividerEdgeGlassConductanceToCenterOfGlassConductance(); | ||
| 218 | |||
| 219 | bool setDividerSolarAbsorptance(double dividerSolarAbsorptance); | ||
| 220 | |||
| 221 | void resetDividerSolarAbsorptance(); | ||
| 222 | |||
| 223 | bool setDividerVisibleAbsorptance(double dividerVisibleAbsorptance); | ||
| 224 | |||
| 225 | void resetDividerVisibleAbsorptance(); | ||
| 226 | |||
| 227 | bool setDividerThermalHemisphericalEmissivity(double dividerThermalHemisphericalEmissivity); | ||
| 228 | |||
| 229 | void resetDividerThermalHemisphericalEmissivity(); | ||
| 230 | |||
| 231 | bool setOutsideRevealDepth(double outsideRevealDepth); | ||
| 232 | |||
| 233 | void resetOutsideRevealDepth(); | ||
| 234 | |||
| 235 | bool setOutsideRevealSolarAbsorptance(double outsideRevealSolarAbsorptance); | ||
| 236 | |||
| 237 | void resetOutsideRevealSolarAbsorptance(); | ||
| 238 | |||
| 239 | bool setInsideSillDepth(double insideSillDepth); | ||
| 240 | |||
| 241 | void resetInsideSillDepth(); | ||
| 242 | |||
| 243 | bool setInsideSillSolarAbsorptance(double insideSillSolarAbsorptance); | ||
| 244 | |||
| 245 | void resetInsideSillSolarAbsorptance(); | ||
| 246 | |||
| 247 | bool setInsideRevealDepth(double insideRevealDepth); | ||
| 248 | |||
| 249 | void resetInsideRevealDepth(); | ||
| 250 | |||
| 251 | bool setInsideRevealSolarAbsorptance(double insideRevealSolarAbsorptance); | ||
| 252 | |||
| 253 | void resetInsideRevealSolarAbsorptance(); | ||
| 254 | |||
| 255 | bool setNFRCProductTypeforAssemblyCalculations(const std::string& nfrcProductTypeforAssemblyCalculations); | ||
| 256 | |||
| 257 | void resetNFRCProductTypeforAssemblyCalculations(); | ||
| 258 | |||
| 259 | //@} | ||
| 260 | /** @name Other */ | ||
| 261 | //@{ | ||
| 262 | |||
| 263 | //@} | ||
| 264 | protected: | ||
| 265 | /// @cond | ||
| 266 | using ImplType = detail::WindowPropertyFrameAndDivider_Impl; | ||
| 267 | |||
| 268 | explicit WindowPropertyFrameAndDivider(std::shared_ptr<detail::WindowPropertyFrameAndDivider_Impl> impl); | ||
| 269 | |||
| 270 | friend class detail::WindowPropertyFrameAndDivider_Impl; | ||
| 271 | friend class Model; | ||
| 272 | friend class IdfObject; | ||
| 273 | friend class openstudio::detail::IdfObject_Impl; | ||
| 274 | /// @endcond | ||
| 275 | private: | ||
| 276 | REGISTER_LOGGER("openstudio.model.WindowPropertyFrameAndDivider"); | ||
| 277 | }; | ||
| 278 | |||
| 279 | /** \relates WindowPropertyFrameAndDivider*/ | ||
| 280 | using OptionalWindowPropertyFrameAndDivider = boost::optional<WindowPropertyFrameAndDivider>; | ||
| 281 | |||
| 282 | /** \relates WindowPropertyFrameAndDivider*/ | ||
| 283 | using WindowPropertyFrameAndDividerVector = std::vector<WindowPropertyFrameAndDivider>; | ||
| 284 | |||
| 285 | } // namespace model | ||
| 286 | } // namespace openstudio | ||
| 287 | |||
| 288 | #endif // MODEL_WINDOWPROPERTYFRAMEANDDIVIDER_HPP | ||
| 289 |