src/model/Screen.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_SCREEN_HPP | ||
| 7 | #define MODEL_SCREEN_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 Screen_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** Screen is a ShadingMaterial that wraps the OpenStudio IDD object 'OS:WindowMaterial:Screen'. */ | ||
| 23 | class MODEL_API Screen : public ShadingMaterial | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit Screen(const Model& model, double diffuseSolarReflectance = 0.08, double diffuseVisibleReflectance = 0.08, | ||
| 30 | double screenMaterialSpacing = 0.00157, double screenMaterialDiameter = 0.000381); | ||
| 31 | |||
| 32 | 6 | virtual ~Screen() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | ✗ | Screen(const Screen& other) = default; | |
| 35 | 2 | Screen(Screen&& other) = default; | |
| 36 | 1 | Screen& operator=(const Screen&) = default; | |
| 37 | ✗ | Screen& operator=(Screen&&) = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | static std::vector<std::string> reflectedBeamTransmittanceAccountingMethodValues(); | ||
| 44 | |||
| 45 | static std::vector<std::string> angleofResolutionforScreenTransmittanceOutputMapValues(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | /** The conductivity of the material in W/m*K. */ | ||
| 51 | double thermalConductivity() const; | ||
| 52 | |||
| 53 | /** The conductance of the material in W/m^2*K. */ | ||
| 54 | double thermalConductance() const; | ||
| 55 | |||
| 56 | /** The resistivity of the material in m*K/W. */ | ||
| 57 | double thermalResistivity() const; | ||
| 58 | |||
| 59 | /** The resistance of the material in m^2*K/W. */ | ||
| 60 | double thermalResistance() const; | ||
| 61 | |||
| 62 | std::string reflectedBeamTransmittanceAccountingMethod() const; | ||
| 63 | |||
| 64 | bool isReflectedBeamTransmittanceAccountingMethodDefaulted() const; | ||
| 65 | |||
| 66 | double diffuseSolarReflectance() const; | ||
| 67 | |||
| 68 | double diffuseVisibleReflectance() const; | ||
| 69 | |||
| 70 | double thermalHemisphericalEmissivity() const; | ||
| 71 | |||
| 72 | bool isThermalHemisphericalEmissivityDefaulted() const; | ||
| 73 | |||
| 74 | double conductivity() const; | ||
| 75 | |||
| 76 | bool isConductivityDefaulted() const; | ||
| 77 | |||
| 78 | double screenMaterialSpacing() const; | ||
| 79 | |||
| 80 | double screenMaterialDiameter() const; | ||
| 81 | |||
| 82 | double screentoGlassDistance() const; | ||
| 83 | |||
| 84 | bool isScreentoGlassDistanceDefaulted() const; | ||
| 85 | |||
| 86 | double topOpeningMultiplier() const; | ||
| 87 | |||
| 88 | bool isTopOpeningMultiplierDefaulted() const; | ||
| 89 | |||
| 90 | double bottomOpeningMultiplier() const; | ||
| 91 | |||
| 92 | bool isBottomOpeningMultiplierDefaulted() const; | ||
| 93 | |||
| 94 | double leftSideOpeningMultiplier() const; | ||
| 95 | |||
| 96 | bool isLeftSideOpeningMultiplierDefaulted() const; | ||
| 97 | |||
| 98 | double rightSideOpeningMultiplier() const; | ||
| 99 | |||
| 100 | bool isRightSideOpeningMultiplierDefaulted() const; | ||
| 101 | |||
| 102 | std::string angleofResolutionforScreenTransmittanceOutputMap() const; | ||
| 103 | |||
| 104 | bool isAngleofResolutionforScreenTransmittanceOutputMapDefaulted() const; | ||
| 105 | |||
| 106 | //@} | ||
| 107 | /** @name Setters */ | ||
| 108 | //@{ | ||
| 109 | |||
| 110 | /** Sets the conductivity of the material in W/m*K, if possible. */ | ||
| 111 | bool setThermalConductivity(double value); | ||
| 112 | |||
| 113 | /** Sets the resistivity of the material in m*K/W, if possible. */ | ||
| 114 | bool setThermalResistivity(double value); | ||
| 115 | |||
| 116 | bool setReflectedBeamTransmittanceAccountingMethod(const std::string& reflectedBeamTransmittanceAccountingMethod); | ||
| 117 | |||
| 118 | void resetReflectedBeamTransmittanceAccountingMethod(); | ||
| 119 | |||
| 120 | bool setDiffuseSolarReflectance(double diffuseSolarReflectance); | ||
| 121 | |||
| 122 | bool setDiffuseVisibleReflectance(double diffuseVisibleReflectance); | ||
| 123 | |||
| 124 | bool setThermalHemisphericalEmissivity(double thermalHemisphericalEmissivity); | ||
| 125 | |||
| 126 | void resetThermalHemisphericalEmissivity(); | ||
| 127 | |||
| 128 | bool setConductivity(double conductivity); | ||
| 129 | |||
| 130 | void resetConductivity(); | ||
| 131 | |||
| 132 | bool setScreenMaterialSpacing(double screenMaterialSpacing); | ||
| 133 | |||
| 134 | bool setScreenMaterialDiameter(double screenMaterialDiameter); | ||
| 135 | |||
| 136 | bool setScreentoGlassDistance(double screentoGlassDistance); | ||
| 137 | |||
| 138 | void resetScreentoGlassDistance(); | ||
| 139 | |||
| 140 | bool setTopOpeningMultiplier(double topOpeningMultiplier); | ||
| 141 | |||
| 142 | void resetTopOpeningMultiplier(); | ||
| 143 | |||
| 144 | bool setBottomOpeningMultiplier(double bottomOpeningMultiplier); | ||
| 145 | |||
| 146 | void resetBottomOpeningMultiplier(); | ||
| 147 | |||
| 148 | bool setLeftSideOpeningMultiplier(double leftSideOpeningMultiplier); | ||
| 149 | |||
| 150 | void resetLeftSideOpeningMultiplier(); | ||
| 151 | |||
| 152 | bool setRightSideOpeningMultiplier(double rightSideOpeningMultiplier); | ||
| 153 | |||
| 154 | void resetRightSideOpeningMultiplier(); | ||
| 155 | |||
| 156 | bool setAngleofResolutionforScreenTransmittanceOutputMap(const std::string& angleofResolutionforScreenTransmittanceOutputMap); | ||
| 157 | |||
| 158 | void resetAngleofResolutionforScreenTransmittanceOutputMap(); | ||
| 159 | |||
| 160 | //@} | ||
| 161 | /** @name Other */ | ||
| 162 | //@{ | ||
| 163 | |||
| 164 | //@} | ||
| 165 | protected: | ||
| 166 | /// @cond | ||
| 167 | using ImplType = detail::Screen_Impl; | ||
| 168 | |||
| 169 | explicit Screen(std::shared_ptr<detail::Screen_Impl> impl); | ||
| 170 | |||
| 171 | friend class detail::Screen_Impl; | ||
| 172 | friend class Model; | ||
| 173 | friend class IdfObject; | ||
| 174 | friend class openstudio::detail::IdfObject_Impl; | ||
| 175 | /// @endcond | ||
| 176 | private: | ||
| 177 | REGISTER_LOGGER("openstudio.model.Screen"); | ||
| 178 | }; | ||
| 179 | |||
| 180 | /** \relates Screen*/ | ||
| 181 | using OptionalScreen = boost::optional<Screen>; | ||
| 182 | |||
| 183 | /** \relates Screen*/ | ||
| 184 | using ScreenVector = std::vector<Screen>; | ||
| 185 | |||
| 186 | } // namespace model | ||
| 187 | } // namespace openstudio | ||
| 188 | |||
| 189 | #endif // MODEL_SCREEN_HPP | ||
| 190 |