src/model/Screen_Impl.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_IMPL_HPP | ||
| 7 | #define MODEL_SCREEN_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ShadingMaterial_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | |||
| 17 | /** Screen_Impl is a ShadingMaterial_Impl that is the implementation class for Screen.*/ | ||
| 18 | class MODEL_API Screen_Impl : public ShadingMaterial_Impl | ||
| 19 | { | ||
| 20 | |||
| 21 | public: | ||
| 22 | /** @name Constructors and Destructors */ | ||
| 23 | //@{ | ||
| 24 | |||
| 25 | Screen_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 26 | |||
| 27 | Screen_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | Screen_Impl(const Screen_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | 3 | virtual ~Screen_Impl() override = default; | |
| 32 | |||
| 33 | //@} | ||
| 34 | |||
| 35 | /** @name Virtual Methods */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 39 | |||
| 40 | virtual IddObjectType iddObjectType() const override; | ||
| 41 | |||
| 42 | //@} | ||
| 43 | /** @name Getters */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | /** Get the thickness of the material. For now is equivalent to screen material diameter. | ||
| 47 | * However, actual thickness of construction should not use this number directly, but should | ||
| 48 | * also factor in the screen to glass distance. */ | ||
| 49 | virtual double thickness() const override; | ||
| 50 | |||
| 51 | /** The conductivity of the material in W/m*K. */ | ||
| 52 | double thermalConductivity() const; | ||
| 53 | |||
| 54 | /** The conductance of the material in W/m^2*K. */ | ||
| 55 | double thermalConductance() const; | ||
| 56 | |||
| 57 | /** The resistivity of the material in m*K/W. */ | ||
| 58 | double thermalResistivity() const; | ||
| 59 | |||
| 60 | /** The resistance of the material in m^2*K/W. */ | ||
| 61 | double thermalResistance() const; | ||
| 62 | |||
| 63 | virtual boost::optional<double> getVisibleTransmittance() const override; | ||
| 64 | |||
| 65 | std::string reflectedBeamTransmittanceAccountingMethod() const; | ||
| 66 | |||
| 67 | bool isReflectedBeamTransmittanceAccountingMethodDefaulted() const; | ||
| 68 | |||
| 69 | double diffuseSolarReflectance() const; | ||
| 70 | |||
| 71 | double diffuseVisibleReflectance() const; | ||
| 72 | |||
| 73 | double thermalHemisphericalEmissivity() const; | ||
| 74 | |||
| 75 | bool isThermalHemisphericalEmissivityDefaulted() const; | ||
| 76 | |||
| 77 | double conductivity() const; | ||
| 78 | |||
| 79 | bool isConductivityDefaulted() const; | ||
| 80 | |||
| 81 | double screenMaterialSpacing() const; | ||
| 82 | |||
| 83 | double screenMaterialDiameter() const; | ||
| 84 | |||
| 85 | double screentoGlassDistance() const; | ||
| 86 | |||
| 87 | bool isScreentoGlassDistanceDefaulted() const; | ||
| 88 | |||
| 89 | double topOpeningMultiplier() const; | ||
| 90 | |||
| 91 | bool isTopOpeningMultiplierDefaulted() const; | ||
| 92 | |||
| 93 | double bottomOpeningMultiplier() const; | ||
| 94 | |||
| 95 | bool isBottomOpeningMultiplierDefaulted() const; | ||
| 96 | |||
| 97 | double leftSideOpeningMultiplier() const; | ||
| 98 | |||
| 99 | bool isLeftSideOpeningMultiplierDefaulted() const; | ||
| 100 | |||
| 101 | double rightSideOpeningMultiplier() const; | ||
| 102 | |||
| 103 | bool isRightSideOpeningMultiplierDefaulted() const; | ||
| 104 | |||
| 105 | std::string angleofResolutionforScreenTransmittanceOutputMap() const; | ||
| 106 | |||
| 107 | bool isAngleofResolutionforScreenTransmittanceOutputMapDefaulted() const; | ||
| 108 | |||
| 109 | //@} | ||
| 110 | /** @name Setters */ | ||
| 111 | //@{ | ||
| 112 | |||
| 113 | /** Set thickness to value (m). For now is equivalent to setting screen material diameter. */ | ||
| 114 | virtual bool setThickness(double value) override; | ||
| 115 | |||
| 116 | /** Sets the conductivity of the material in W/m*K, if possible. */ | ||
| 117 | bool setThermalConductivity(double value); | ||
| 118 | |||
| 119 | /** Sets the resistivity of the material in m*K/W, if possible. */ | ||
| 120 | bool setThermalResistivity(double value); | ||
| 121 | |||
| 122 | bool setReflectedBeamTransmittanceAccountingMethod(const std::string& reflectedBeamTransmittanceAccountingMethod); | ||
| 123 | |||
| 124 | void resetReflectedBeamTransmittanceAccountingMethod(); | ||
| 125 | |||
| 126 | bool setDiffuseSolarReflectance(double diffuseSolarReflectance); | ||
| 127 | |||
| 128 | bool setDiffuseVisibleReflectance(double diffuseVisibleReflectance); | ||
| 129 | |||
| 130 | bool setThermalHemisphericalEmissivity(double thermalHemisphericalEmissivity); | ||
| 131 | |||
| 132 | void resetThermalHemisphericalEmissivity(); | ||
| 133 | |||
| 134 | bool setConductivity(double conductivity); | ||
| 135 | |||
| 136 | void resetConductivity(); | ||
| 137 | |||
| 138 | bool setScreenMaterialSpacing(double screenMaterialSpacing); | ||
| 139 | |||
| 140 | bool setScreenMaterialDiameter(double screenMaterialDiameter); | ||
| 141 | |||
| 142 | bool setScreentoGlassDistance(double screentoGlassDistance); | ||
| 143 | |||
| 144 | void resetScreentoGlassDistance(); | ||
| 145 | |||
| 146 | bool setTopOpeningMultiplier(double topOpeningMultiplier); | ||
| 147 | |||
| 148 | void resetTopOpeningMultiplier(); | ||
| 149 | |||
| 150 | bool setBottomOpeningMultiplier(double bottomOpeningMultiplier); | ||
| 151 | |||
| 152 | void resetBottomOpeningMultiplier(); | ||
| 153 | |||
| 154 | bool setLeftSideOpeningMultiplier(double leftSideOpeningMultiplier); | ||
| 155 | |||
| 156 | void resetLeftSideOpeningMultiplier(); | ||
| 157 | |||
| 158 | bool setRightSideOpeningMultiplier(double rightSideOpeningMultiplier); | ||
| 159 | |||
| 160 | void resetRightSideOpeningMultiplier(); | ||
| 161 | |||
| 162 | bool setAngleofResolutionforScreenTransmittanceOutputMap(const std::string& angleofResolutionforScreenTransmittanceOutputMap); | ||
| 163 | |||
| 164 | void resetAngleofResolutionforScreenTransmittanceOutputMap(); | ||
| 165 | |||
| 166 | //@} | ||
| 167 | /** @name Other */ | ||
| 168 | //@{ | ||
| 169 | |||
| 170 | //@} | ||
| 171 | protected: | ||
| 172 | private: | ||
| 173 | − | REGISTER_LOGGER("openstudio.model.Screen"); | |
| 174 | |||
| 175 | std::vector<std::string> reflectedBeamTransmittanceAccountingMethodValues() const; | ||
| 176 | std::vector<std::string> angleofResolutionforScreenTransmittanceOutputMapValues() const; | ||
| 177 | }; | ||
| 178 | |||
| 179 | } // namespace detail | ||
| 180 | |||
| 181 | } // namespace model | ||
| 182 | } // namespace openstudio | ||
| 183 | |||
| 184 | #endif // MODEL_SCREEN_IMPL_HPP | ||
| 185 |