src/model/Shade_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_SHADE_IMPL_HPP | ||
| 7 | #define MODEL_SHADE_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 | /** Shade_Impl is a ShadingMaterial_Impl that is the implementation class for Shade.*/ | ||
| 18 | class MODEL_API Shade_Impl : public ShadingMaterial_Impl | ||
| 19 | { | ||
| 20 | |||
| 21 | public: | ||
| 22 | /** @name Constructors and Destructors */ | ||
| 23 | //@{ | ||
| 24 | |||
| 25 | Shade_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 26 | |||
| 27 | Shade_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | Shade_Impl(const Shade_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | 3 | virtual ~Shade_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. Note that the construction may need to add additional | ||
| 47 | * thickness for an air gap, depending on context. */ | ||
| 48 | virtual double thickness() const override; | ||
| 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 | double thermalTransmittance() const; | ||
| 63 | |||
| 64 | double solarTransmittance() const; | ||
| 65 | |||
| 66 | double solarAbsorptance() const; | ||
| 67 | |||
| 68 | double solarReflectance() const; | ||
| 69 | |||
| 70 | double visibleAbsorptance() const; | ||
| 71 | |||
| 72 | virtual boost::optional<double> interiorVisibleAbsorptance() const override; | ||
| 73 | |||
| 74 | virtual boost::optional<double> exteriorVisibleAbsorptance() const override; | ||
| 75 | |||
| 76 | double visibleReflectance() const; | ||
| 77 | |||
| 78 | double visibleTransmittance() const; | ||
| 79 | |||
| 80 | virtual boost::optional<double> getVisibleTransmittance() const override; | ||
| 81 | |||
| 82 | double thermalHemisphericalEmissivity() const; | ||
| 83 | |||
| 84 | double conductivity() const; | ||
| 85 | |||
| 86 | double shadetoGlassDistance() const; | ||
| 87 | |||
| 88 | bool isShadetoGlassDistanceDefaulted() const; | ||
| 89 | |||
| 90 | double topOpeningMultiplier() const; | ||
| 91 | |||
| 92 | bool isTopOpeningMultiplierDefaulted() const; | ||
| 93 | |||
| 94 | double bottomOpeningMultiplier() const; | ||
| 95 | |||
| 96 | bool isBottomOpeningMultiplierDefaulted() const; | ||
| 97 | |||
| 98 | double leftSideOpeningMultiplier() const; | ||
| 99 | |||
| 100 | bool isLeftSideOpeningMultiplierDefaulted() const; | ||
| 101 | |||
| 102 | double rightSideOpeningMultiplier() const; | ||
| 103 | |||
| 104 | bool isRightSideOpeningMultiplierDefaulted() const; | ||
| 105 | |||
| 106 | double airflowPermeability() const; | ||
| 107 | |||
| 108 | bool isAirflowPermeabilityDefaulted() const; | ||
| 109 | |||
| 110 | //@} | ||
| 111 | /** @name Setters */ | ||
| 112 | //@{ | ||
| 113 | |||
| 114 | /** Set thickness to value (m). */ | ||
| 115 | virtual bool setThickness(double thickness) override; | ||
| 116 | |||
| 117 | /** Sets the conductivity of the material in W/m*K, if possible. */ | ||
| 118 | bool setThermalConductivity(double value); | ||
| 119 | |||
| 120 | /** Sets the conductance of the material in W/m^2*K, if possible. */ | ||
| 121 | bool setThermalConductance(double value); | ||
| 122 | |||
| 123 | /** Sets the resistivity of the material in m*K/W, if possible. */ | ||
| 124 | bool setThermalResistivity(double value); | ||
| 125 | |||
| 126 | /** Sets the resistance of the material in m^2*K/W, if possible. */ | ||
| 127 | bool setThermalResistance(double value); | ||
| 128 | |||
| 129 | bool setThermalTransmittance(double thermalTransmittance); | ||
| 130 | |||
| 131 | bool setSolarTransmittance(double solarTransmittance); | ||
| 132 | |||
| 133 | bool setSolarReflectance(double solarReflectance); | ||
| 134 | |||
| 135 | bool setVisibleTransmittance(double visibleTransmittance); | ||
| 136 | |||
| 137 | bool setVisibleReflectance(double visibleReflectance); | ||
| 138 | |||
| 139 | bool setThermalHemisphericalEmissivity(double thermalHemisphericalEmissivity); | ||
| 140 | |||
| 141 | bool setConductivity(double conductivity); | ||
| 142 | |||
| 143 | bool setShadetoGlassDistance(double shadetoGlassDistance); | ||
| 144 | |||
| 145 | void resetShadetoGlassDistance(); | ||
| 146 | |||
| 147 | bool setTopOpeningMultiplier(double topOpeningMultiplier); | ||
| 148 | |||
| 149 | void resetTopOpeningMultiplier(); | ||
| 150 | |||
| 151 | bool setBottomOpeningMultiplier(double bottomOpeningMultiplier); | ||
| 152 | |||
| 153 | void resetBottomOpeningMultiplier(); | ||
| 154 | |||
| 155 | bool setLeftSideOpeningMultiplier(double leftSideOpeningMultiplier); | ||
| 156 | |||
| 157 | void resetLeftSideOpeningMultiplier(); | ||
| 158 | |||
| 159 | bool setRightSideOpeningMultiplier(double rightSideOpeningMultiplier); | ||
| 160 | |||
| 161 | void resetRightSideOpeningMultiplier(); | ||
| 162 | |||
| 163 | bool setAirflowPermeability(double airflowPermeability); | ||
| 164 | |||
| 165 | void resetAirflowPermeability(); | ||
| 166 | |||
| 167 | //@} | ||
| 168 | /** @name Other */ | ||
| 169 | //@{ | ||
| 170 | |||
| 171 | //@} | ||
| 172 | protected: | ||
| 173 | private: | ||
| 174 | − | REGISTER_LOGGER("openstudio.model.Shade"); | |
| 175 | }; | ||
| 176 | |||
| 177 | } // namespace detail | ||
| 178 | |||
| 179 | } // namespace model | ||
| 180 | } // namespace openstudio | ||
| 181 | |||
| 182 | #endif // MODEL_SHADE_IMPL_HPP | ||
| 183 |