src/model/Blind.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_BLIND_HPP | ||
| 7 | #define MODEL_BLIND_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ShadingMaterial.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class Blind_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** Blind is a ShadingMaterial that wraps the OpenStudio IDD object 'OS:WindowMaterial:Blind'. */ | ||
| 23 | class MODEL_API Blind : public ShadingMaterial | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit Blind(const Model& model, double slatWidth = 0.025, double slatSeparation = 0.01875, double frontSideSlatBeamSolarReflectance = 0.5, | ||
| 30 | double backSideSlatBeamSolarReflectance = 0.5, double frontSideSlatDiffuseSolarReflectance = 0.5, | ||
| 31 | double backSideSlatDiffuseSolarReflectance = 0.5, double slatBeamVisibleTransmittance = 0.0); | ||
| 32 | |||
| 33 | 52 | virtual ~Blind() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | ✗ | Blind(const Blind& other) = default; | |
| 36 | 16 | Blind(Blind&& other) = default; | |
| 37 | 1 | Blind& operator=(const Blind&) = default; | |
| 38 | ✗ | Blind& operator=(Blind&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | static std::vector<std::string> slatOrientationValues(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | std::string slatOrientation() const; | ||
| 50 | |||
| 51 | bool isSlatOrientationDefaulted() const; | ||
| 52 | |||
| 53 | double slatWidth() const; | ||
| 54 | |||
| 55 | double slatSeparation() const; | ||
| 56 | |||
| 57 | double slatThickness() const; | ||
| 58 | |||
| 59 | bool isSlatThicknessDefaulted() const; | ||
| 60 | |||
| 61 | double slatAngle() const; | ||
| 62 | |||
| 63 | bool isSlatAngleDefaulted() const; | ||
| 64 | |||
| 65 | double slatConductivity() const; | ||
| 66 | |||
| 67 | bool isSlatConductivityDefaulted() const; | ||
| 68 | |||
| 69 | double slatBeamSolarTransmittance() const; | ||
| 70 | |||
| 71 | bool isSlatBeamSolarTransmittanceDefaulted() const; | ||
| 72 | |||
| 73 | double frontSideSlatBeamSolarReflectance() const; | ||
| 74 | |||
| 75 | double backSideSlatBeamSolarReflectance() const; | ||
| 76 | |||
| 77 | double slatDiffuseSolarTransmittance() const; | ||
| 78 | |||
| 79 | bool isSlatDiffuseSolarTransmittanceDefaulted() const; | ||
| 80 | |||
| 81 | double frontSideSlatDiffuseSolarReflectance() const; | ||
| 82 | |||
| 83 | double backSideSlatDiffuseSolarReflectance() const; | ||
| 84 | |||
| 85 | double slatBeamVisibleTransmittance() const; | ||
| 86 | |||
| 87 | // TODO: has a default, should be double, not optional double | ||
| 88 | boost::optional<double> frontSideSlatBeamVisibleReflectance() const; | ||
| 89 | |||
| 90 | // TODO: has a default, should be double, not optional double | ||
| 91 | boost::optional<double> backSideSlatBeamVisibleReflectance() const; | ||
| 92 | |||
| 93 | double slatDiffuseVisibleTransmittance() const; | ||
| 94 | |||
| 95 | bool isSlatDiffuseVisibleTransmittanceDefaulted() const; | ||
| 96 | |||
| 97 | // TODO: has a default, should be double, not optional double | ||
| 98 | boost::optional<double> frontSideSlatDiffuseVisibleReflectance() const; | ||
| 99 | |||
| 100 | // TODO: has a default, should be double, not optional double | ||
| 101 | boost::optional<double> backSideSlatDiffuseVisibleReflectance() const; | ||
| 102 | |||
| 103 | double slatInfraredHemisphericalTransmittance() const; | ||
| 104 | |||
| 105 | bool isSlatInfraredHemisphericalTransmittanceDefaulted() const; | ||
| 106 | |||
| 107 | double frontSideSlatInfraredHemisphericalEmissivity() const; | ||
| 108 | |||
| 109 | bool isFrontSideSlatInfraredHemisphericalEmissivityDefaulted() const; | ||
| 110 | |||
| 111 | double backSideSlatInfraredHemisphericalEmissivity() const; | ||
| 112 | |||
| 113 | bool isBackSideSlatInfraredHemisphericalEmissivityDefaulted() const; | ||
| 114 | |||
| 115 | double blindtoGlassDistance() const; | ||
| 116 | |||
| 117 | bool isBlindtoGlassDistanceDefaulted() const; | ||
| 118 | |||
| 119 | double blindTopOpeningMultiplier() const; | ||
| 120 | |||
| 121 | bool isBlindTopOpeningMultiplierDefaulted() const; | ||
| 122 | |||
| 123 | double blindBottomOpeningMultiplier() const; | ||
| 124 | |||
| 125 | bool isBlindBottomOpeningMultiplierDefaulted() const; | ||
| 126 | |||
| 127 | double blindLeftSideOpeningMultiplier() const; | ||
| 128 | |||
| 129 | bool isBlindLeftSideOpeningMultiplierDefaulted() const; | ||
| 130 | |||
| 131 | double blindRightSideOpeningMultiplier() const; | ||
| 132 | |||
| 133 | bool isBlindRightSideOpeningMultiplierDefaulted() const; | ||
| 134 | |||
| 135 | double minimumSlatAngle() const; | ||
| 136 | |||
| 137 | bool isMinimumSlatAngleDefaulted() const; | ||
| 138 | |||
| 139 | double maximumSlatAngle() const; | ||
| 140 | |||
| 141 | bool isMaximumSlatAngleDefaulted() const; | ||
| 142 | |||
| 143 | //@} | ||
| 144 | /** @name Setters */ | ||
| 145 | //@{ | ||
| 146 | |||
| 147 | bool setSlatOrientation(const std::string& slatOrientation); | ||
| 148 | |||
| 149 | void resetSlatOrientation(); | ||
| 150 | |||
| 151 | bool setSlatWidth(double slatWidth); | ||
| 152 | |||
| 153 | bool setSlatSeparation(double slatSeparation); | ||
| 154 | |||
| 155 | bool setSlatThickness(double slatThickness); | ||
| 156 | |||
| 157 | void resetSlatThickness(); | ||
| 158 | |||
| 159 | bool setSlatAngle(double slatAngle); | ||
| 160 | |||
| 161 | void resetSlatAngle(); | ||
| 162 | |||
| 163 | bool setSlatConductivity(double slatConductivity); | ||
| 164 | |||
| 165 | void resetSlatConductivity(); | ||
| 166 | |||
| 167 | bool setSlatBeamSolarTransmittance(double slatBeamSolarTransmittance); | ||
| 168 | |||
| 169 | void resetSlatBeamSolarTransmittance(); | ||
| 170 | |||
| 171 | bool setFrontSideSlatBeamSolarReflectance(double frontSideSlatBeamSolarReflectance); | ||
| 172 | |||
| 173 | bool setBackSideSlatBeamSolarReflectance(double backSideSlatBeamSolarReflectance); | ||
| 174 | |||
| 175 | bool setSlatDiffuseSolarTransmittance(double slatDiffuseSolarTransmittance); | ||
| 176 | |||
| 177 | void resetSlatDiffuseSolarTransmittance(); | ||
| 178 | |||
| 179 | bool setFrontSideSlatDiffuseSolarReflectance(double frontSideSlatDiffuseSolarReflectance); | ||
| 180 | |||
| 181 | bool setBackSideSlatDiffuseSolarReflectance(double backSideSlatDiffuseSolarReflectance); | ||
| 182 | |||
| 183 | bool setSlatBeamVisibleTransmittance(double slatBeamVisibleTransmittance); | ||
| 184 | |||
| 185 | bool setFrontSideSlatBeamVisibleReflectance(double frontSideSlatBeamVisibleReflectance); | ||
| 186 | |||
| 187 | void resetFrontSideSlatBeamVisibleReflectance(); | ||
| 188 | |||
| 189 | bool setBackSideSlatBeamVisibleReflectance(double backSideSlatBeamVisibleReflectance); | ||
| 190 | |||
| 191 | void resetBackSideSlatBeamVisibleReflectance(); | ||
| 192 | |||
| 193 | bool setSlatDiffuseVisibleTransmittance(double slatDiffuseVisibleTransmittance); | ||
| 194 | |||
| 195 | void resetSlatDiffuseVisibleTransmittance(); | ||
| 196 | |||
| 197 | bool setFrontSideSlatDiffuseVisibleReflectance(double frontSideSlatDiffuseVisibleReflectance); | ||
| 198 | |||
| 199 | void resetFrontSideSlatDiffuseVisibleReflectance(); | ||
| 200 | |||
| 201 | bool setBackSideSlatDiffuseVisibleReflectance(double backSideSlatDiffuseVisibleReflectance); | ||
| 202 | |||
| 203 | void resetBackSideSlatDiffuseVisibleReflectance(); | ||
| 204 | |||
| 205 | bool setSlatInfraredHemisphericalTransmittance(double slatInfraredHemisphericalTransmittance); | ||
| 206 | |||
| 207 | void resetSlatInfraredHemisphericalTransmittance(); | ||
| 208 | |||
| 209 | bool setFrontSideSlatInfraredHemisphericalEmissivity(double frontSideSlatInfraredHemisphericalEmissivity); | ||
| 210 | |||
| 211 | void resetFrontSideSlatInfraredHemisphericalEmissivity(); | ||
| 212 | |||
| 213 | bool setBackSideSlatInfraredHemisphericalEmissivity(double backSideSlatInfraredHemisphericalEmissivity); | ||
| 214 | |||
| 215 | void resetBackSideSlatInfraredHemisphericalEmissivity(); | ||
| 216 | |||
| 217 | bool setBlindtoGlassDistance(double blindtoGlassDistance); | ||
| 218 | |||
| 219 | void resetBlindtoGlassDistance(); | ||
| 220 | |||
| 221 | bool setBlindTopOpeningMultiplier(double blindTopOpeningMultiplier); | ||
| 222 | |||
| 223 | void resetBlindTopOpeningMultiplier(); | ||
| 224 | |||
| 225 | bool setBlindBottomOpeningMultiplier(double blindBottomOpeningMultiplier); | ||
| 226 | |||
| 227 | void resetBlindBottomOpeningMultiplier(); | ||
| 228 | |||
| 229 | bool setBlindLeftSideOpeningMultiplier(double blindLeftSideOpeningMultiplier); | ||
| 230 | |||
| 231 | void resetBlindLeftSideOpeningMultiplier(); | ||
| 232 | |||
| 233 | bool setBlindRightSideOpeningMultiplier(double blindRightSideOpeningMultiplier); | ||
| 234 | |||
| 235 | void resetBlindRightSideOpeningMultiplier(); | ||
| 236 | |||
| 237 | bool setMinimumSlatAngle(double minimumSlatAngle); | ||
| 238 | |||
| 239 | void resetMinimumSlatAngle(); | ||
| 240 | |||
| 241 | bool setMaximumSlatAngle(double maximumSlatAngle); | ||
| 242 | |||
| 243 | void resetMaximumSlatAngle(); | ||
| 244 | |||
| 245 | //@} | ||
| 246 | /** @name Other */ | ||
| 247 | //@{ | ||
| 248 | |||
| 249 | //@} | ||
| 250 | protected: | ||
| 251 | /// @cond | ||
| 252 | using ImplType = detail::Blind_Impl; | ||
| 253 | |||
| 254 | explicit Blind(std::shared_ptr<detail::Blind_Impl> impl); | ||
| 255 | |||
| 256 | friend class detail::Blind_Impl; | ||
| 257 | friend class Model; | ||
| 258 | friend class IdfObject; | ||
| 259 | friend class openstudio::detail::IdfObject_Impl; | ||
| 260 | /// @endcond | ||
| 261 | private: | ||
| 262 | REGISTER_LOGGER("openstudio.model.Blind"); | ||
| 263 | }; | ||
| 264 | |||
| 265 | /** \relates Blind*/ | ||
| 266 | using OptionalBlind = boost::optional<Blind>; | ||
| 267 | |||
| 268 | /** \relates Blind*/ | ||
| 269 | using BlindVector = std::vector<Blind>; | ||
| 270 | |||
| 271 | } // namespace model | ||
| 272 | } // namespace openstudio | ||
| 273 | |||
| 274 | #endif // MODEL_BLIND_HPP | ||
| 275 |