src/model/Blind_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_BLIND_IMPL_HPP | ||
| 7 | #define MODEL_BLIND_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 | /** Blind_Impl is a ShadingMaterial_Impl that is the implementation class for Blind.*/ | ||
| 18 | class MODEL_API Blind_Impl : public ShadingMaterial_Impl | ||
| 19 | { | ||
| 20 | |||
| 21 | public: | ||
| 22 | /** @name Constructors and Destructors */ | ||
| 23 | //@{ | ||
| 24 | |||
| 25 | Blind_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 26 | |||
| 27 | Blind_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | Blind_Impl(const Blind_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | 27 | virtual ~Blind_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 slat thickness. */ | ||
| 47 | virtual double thickness() const override; | ||
| 48 | |||
| 49 | std::string slatOrientation() const; | ||
| 50 | /** Throws because blind has beam and diffuse visible transmittance. */ | ||
| 51 | virtual boost::optional<double> getVisibleTransmittance() const override; | ||
| 52 | |||
| 53 | bool isSlatOrientationDefaulted() const; | ||
| 54 | |||
| 55 | double slatWidth() const; | ||
| 56 | |||
| 57 | double slatSeparation() const; | ||
| 58 | |||
| 59 | double slatThickness() const; | ||
| 60 | |||
| 61 | bool isSlatThicknessDefaulted() const; | ||
| 62 | |||
| 63 | double slatAngle() const; | ||
| 64 | |||
| 65 | bool isSlatAngleDefaulted() const; | ||
| 66 | |||
| 67 | double slatConductivity() const; | ||
| 68 | |||
| 69 | bool isSlatConductivityDefaulted() const; | ||
| 70 | |||
| 71 | double slatBeamSolarTransmittance() const; | ||
| 72 | |||
| 73 | bool isSlatBeamSolarTransmittanceDefaulted() const; | ||
| 74 | |||
| 75 | double frontSideSlatBeamSolarReflectance() const; | ||
| 76 | |||
| 77 | double backSideSlatBeamSolarReflectance() const; | ||
| 78 | |||
| 79 | double slatDiffuseSolarTransmittance() const; | ||
| 80 | |||
| 81 | bool isSlatDiffuseSolarTransmittanceDefaulted() const; | ||
| 82 | |||
| 83 | double frontSideSlatDiffuseSolarReflectance() const; | ||
| 84 | |||
| 85 | double backSideSlatDiffuseSolarReflectance() const; | ||
| 86 | |||
| 87 | double slatBeamVisibleTransmittance() const; | ||
| 88 | |||
| 89 | boost::optional<double> frontSideSlatBeamVisibleReflectance() const; | ||
| 90 | |||
| 91 | boost::optional<double> backSideSlatBeamVisibleReflectance() const; | ||
| 92 | |||
| 93 | double slatDiffuseVisibleTransmittance() const; | ||
| 94 | |||
| 95 | bool isSlatDiffuseVisibleTransmittanceDefaulted() const; | ||
| 96 | |||
| 97 | boost::optional<double> frontSideSlatDiffuseVisibleReflectance() const; | ||
| 98 | |||
| 99 | boost::optional<double> backSideSlatDiffuseVisibleReflectance() const; | ||
| 100 | |||
| 101 | double slatInfraredHemisphericalTransmittance() const; | ||
| 102 | |||
| 103 | bool isSlatInfraredHemisphericalTransmittanceDefaulted() const; | ||
| 104 | |||
| 105 | double frontSideSlatInfraredHemisphericalEmissivity() const; | ||
| 106 | |||
| 107 | bool isFrontSideSlatInfraredHemisphericalEmissivityDefaulted() const; | ||
| 108 | |||
| 109 | double backSideSlatInfraredHemisphericalEmissivity() const; | ||
| 110 | |||
| 111 | bool isBackSideSlatInfraredHemisphericalEmissivityDefaulted() const; | ||
| 112 | |||
| 113 | double blindtoGlassDistance() const; | ||
| 114 | |||
| 115 | bool isBlindtoGlassDistanceDefaulted() const; | ||
| 116 | |||
| 117 | double blindTopOpeningMultiplier() const; | ||
| 118 | |||
| 119 | bool isBlindTopOpeningMultiplierDefaulted() const; | ||
| 120 | |||
| 121 | double blindBottomOpeningMultiplier() const; | ||
| 122 | |||
| 123 | bool isBlindBottomOpeningMultiplierDefaulted() const; | ||
| 124 | |||
| 125 | double blindLeftSideOpeningMultiplier() const; | ||
| 126 | |||
| 127 | bool isBlindLeftSideOpeningMultiplierDefaulted() const; | ||
| 128 | |||
| 129 | double blindRightSideOpeningMultiplier() const; | ||
| 130 | |||
| 131 | bool isBlindRightSideOpeningMultiplierDefaulted() const; | ||
| 132 | |||
| 133 | double minimumSlatAngle() const; | ||
| 134 | |||
| 135 | bool isMinimumSlatAngleDefaulted() const; | ||
| 136 | |||
| 137 | double maximumSlatAngle() const; | ||
| 138 | |||
| 139 | bool isMaximumSlatAngleDefaulted() const; | ||
| 140 | |||
| 141 | //@} | ||
| 142 | /** @name Setters */ | ||
| 143 | //@{ | ||
| 144 | |||
| 145 | /** Set thickness to value (m). For now is equivalent to setting slat thickness. */ | ||
| 146 | virtual bool setThickness(double value) override; | ||
| 147 | |||
| 148 | bool setSlatOrientation(const std::string& slatOrientation); | ||
| 149 | |||
| 150 | void resetSlatOrientation(); | ||
| 151 | |||
| 152 | bool setSlatWidth(double slatWidth); | ||
| 153 | |||
| 154 | bool setSlatSeparation(double slatSeparation); | ||
| 155 | |||
| 156 | bool setSlatThickness(double slatThickness); | ||
| 157 | |||
| 158 | void resetSlatThickness(); | ||
| 159 | |||
| 160 | bool setSlatAngle(double slatAngle); | ||
| 161 | |||
| 162 | void resetSlatAngle(); | ||
| 163 | |||
| 164 | bool setSlatConductivity(double slatConductivity); | ||
| 165 | |||
| 166 | void resetSlatConductivity(); | ||
| 167 | |||
| 168 | bool setSlatBeamSolarTransmittance(double slatBeamSolarTransmittance); | ||
| 169 | |||
| 170 | void resetSlatBeamSolarTransmittance(); | ||
| 171 | |||
| 172 | bool setFrontSideSlatBeamSolarReflectance(double frontSideSlatBeamSolarReflectance); | ||
| 173 | |||
| 174 | bool setBackSideSlatBeamSolarReflectance(double backSideSlatBeamSolarReflectance); | ||
| 175 | |||
| 176 | bool setSlatDiffuseSolarTransmittance(double slatDiffuseSolarTransmittance); | ||
| 177 | |||
| 178 | void resetSlatDiffuseSolarTransmittance(); | ||
| 179 | |||
| 180 | bool setFrontSideSlatDiffuseSolarReflectance(double frontSideSlatDiffuseSolarReflectance); | ||
| 181 | |||
| 182 | bool setBackSideSlatDiffuseSolarReflectance(double backSideSlatDiffuseSolarReflectance); | ||
| 183 | |||
| 184 | bool setSlatBeamVisibleTransmittance(double slatBeamVisibleTransmittance); | ||
| 185 | |||
| 186 | bool setFrontSideSlatBeamVisibleReflectance(boost::optional<double> frontSideSlatBeamVisibleReflectance); | ||
| 187 | |||
| 188 | void resetFrontSideSlatBeamVisibleReflectance(); | ||
| 189 | |||
| 190 | bool setBackSideSlatBeamVisibleReflectance(boost::optional<double> backSideSlatBeamVisibleReflectance); | ||
| 191 | |||
| 192 | void resetBackSideSlatBeamVisibleReflectance(); | ||
| 193 | |||
| 194 | bool setSlatDiffuseVisibleTransmittance(double slatDiffuseVisibleTransmittance); | ||
| 195 | |||
| 196 | void resetSlatDiffuseVisibleTransmittance(); | ||
| 197 | |||
| 198 | bool setFrontSideSlatDiffuseVisibleReflectance(boost::optional<double> frontSideSlatDiffuseVisibleReflectance); | ||
| 199 | |||
| 200 | void resetFrontSideSlatDiffuseVisibleReflectance(); | ||
| 201 | |||
| 202 | bool setBackSideSlatDiffuseVisibleReflectance(boost::optional<double> backSideSlatDiffuseVisibleReflectance); | ||
| 203 | |||
| 204 | void resetBackSideSlatDiffuseVisibleReflectance(); | ||
| 205 | |||
| 206 | bool setSlatInfraredHemisphericalTransmittance(double slatInfraredHemisphericalTransmittance); | ||
| 207 | |||
| 208 | void resetSlatInfraredHemisphericalTransmittance(); | ||
| 209 | |||
| 210 | bool setFrontSideSlatInfraredHemisphericalEmissivity(double frontSideSlatInfraredHemisphericalEmissivity); | ||
| 211 | |||
| 212 | void resetFrontSideSlatInfraredHemisphericalEmissivity(); | ||
| 213 | |||
| 214 | bool setBackSideSlatInfraredHemisphericalEmissivity(double backSideSlatInfraredHemisphericalEmissivity); | ||
| 215 | |||
| 216 | void resetBackSideSlatInfraredHemisphericalEmissivity(); | ||
| 217 | |||
| 218 | bool setBlindtoGlassDistance(double blindtoGlassDistance); | ||
| 219 | |||
| 220 | void resetBlindtoGlassDistance(); | ||
| 221 | |||
| 222 | bool setBlindTopOpeningMultiplier(double blindTopOpeningMultiplier); | ||
| 223 | |||
| 224 | void resetBlindTopOpeningMultiplier(); | ||
| 225 | |||
| 226 | bool setBlindBottomOpeningMultiplier(double blindBottomOpeningMultiplier); | ||
| 227 | |||
| 228 | void resetBlindBottomOpeningMultiplier(); | ||
| 229 | |||
| 230 | bool setBlindLeftSideOpeningMultiplier(double blindLeftSideOpeningMultiplier); | ||
| 231 | |||
| 232 | void resetBlindLeftSideOpeningMultiplier(); | ||
| 233 | |||
| 234 | bool setBlindRightSideOpeningMultiplier(double blindRightSideOpeningMultiplier); | ||
| 235 | |||
| 236 | void resetBlindRightSideOpeningMultiplier(); | ||
| 237 | |||
| 238 | bool setMinimumSlatAngle(double minimumSlatAngle); | ||
| 239 | |||
| 240 | void resetMinimumSlatAngle(); | ||
| 241 | |||
| 242 | bool setMaximumSlatAngle(double maximumSlatAngle); | ||
| 243 | |||
| 244 | void resetMaximumSlatAngle(); | ||
| 245 | |||
| 246 | //@} | ||
| 247 | /** @name Other */ | ||
| 248 | //@{ | ||
| 249 | |||
| 250 | //@} | ||
| 251 | protected: | ||
| 252 | private: | ||
| 253 | − | REGISTER_LOGGER("openstudio.model.Blind"); | |
| 254 | |||
| 255 | std::vector<std::string> slatOrientationValues() const; | ||
| 256 | }; | ||
| 257 | |||
| 258 | } // namespace detail | ||
| 259 | |||
| 260 | } // namespace model | ||
| 261 | } // namespace openstudio | ||
| 262 | |||
| 263 | #endif // MODEL_BLIND_IMPL_HPP | ||
| 264 |