src/model/DesignDay.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_DESIGNDAY_HPP | ||
| 7 | #define MODEL_DESIGNDAY_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SizingPeriod.hpp" | ||
| 11 | #include "../utilities/core/Deprecated.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class ScheduleDay; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | class DesignDay_Impl; | ||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | class MODEL_API DesignDay : public SizingPeriod | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | // constructor | ||
| 26 | explicit DesignDay(const Model& model); | ||
| 27 | |||
| 28 | /** @name Static Methods */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | static IddObjectType iddObjectType(); | ||
| 32 | |||
| 33 | static std::vector<std::string> validDayTypeValues(); | ||
| 34 | |||
| 35 | OS_DEPRECATED(3, 3, 0) static std::vector<std::string> validHumidityIndicatingTypeValues(); | ||
| 36 | |||
| 37 | static std::vector<std::string> validHumidityConditionTypeValues(); | ||
| 38 | |||
| 39 | static std::vector<std::string> validDryBulbTemperatureRangeModifierTypeValues(); | ||
| 40 | |||
| 41 | static std::vector<std::string> validSolarModelIndicatorValues(); | ||
| 42 | |||
| 43 | static std::vector<std::string> validBeginEnvironmentResetModeValues(); | ||
| 44 | |||
| 45 | //@} | ||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | double maximumDryBulbTemperature() const; | ||
| 50 | |||
| 51 | bool isMaximumDryBulbTemperatureDefaulted() const; | ||
| 52 | |||
| 53 | double dailyDryBulbTemperatureRange() const; | ||
| 54 | |||
| 55 | bool isDailyDryBulbTemperatureRangeDefaulted() const; | ||
| 56 | |||
| 57 | OS_DEPRECATED(3, 3, 0) double humidityIndicatingConditionsAtMaximumDryBulb() const; | ||
| 58 | |||
| 59 | OS_DEPRECATED(3, 3, 0) bool isHumidityIndicatingConditionsAtMaximumDryBulbDefaulted() const; | ||
| 60 | |||
| 61 | double barometricPressure() const; | ||
| 62 | |||
| 63 | bool isBarometricPressureDefaulted() const; | ||
| 64 | |||
| 65 | double windSpeed() const; | ||
| 66 | |||
| 67 | bool isWindSpeedDefaulted() const; | ||
| 68 | |||
| 69 | double windDirection() const; | ||
| 70 | |||
| 71 | bool isWindDirectionDefaulted() const; | ||
| 72 | |||
| 73 | double skyClearness() const; | ||
| 74 | |||
| 75 | bool isSkyClearnessDefaulted() const; | ||
| 76 | |||
| 77 | bool rainIndicator() const; | ||
| 78 | |||
| 79 | bool isRainIndicatorDefaulted() const; | ||
| 80 | |||
| 81 | bool snowIndicator() const; | ||
| 82 | |||
| 83 | bool isSnowIndicatorDefaulted() const; | ||
| 84 | |||
| 85 | int dayOfMonth() const; | ||
| 86 | |||
| 87 | bool isDayOfMonthDefaulted() const; | ||
| 88 | |||
| 89 | int month() const; | ||
| 90 | |||
| 91 | bool isMonthDefaulted() const; | ||
| 92 | |||
| 93 | std::string dayType() const; | ||
| 94 | |||
| 95 | bool isDayTypeDefaulted() const; | ||
| 96 | |||
| 97 | bool daylightSavingTimeIndicator() const; | ||
| 98 | |||
| 99 | bool isDaylightSavingTimeIndicatorDefaulted() const; | ||
| 100 | |||
| 101 | OS_DEPRECATED(3, 3, 0) std::string humidityIndicatingType() const; | ||
| 102 | |||
| 103 | std::string humidityConditionType() const; | ||
| 104 | |||
| 105 | OS_DEPRECATED(3, 3, 0) bool isHumidityIndicatingTypeDefaulted() const; | ||
| 106 | |||
| 107 | bool isHumidityConditionTypeDefaulted() const; | ||
| 108 | |||
| 109 | OS_DEPRECATED(3, 3, 0) boost::optional<ScheduleDay> humidityIndicatingDaySchedule() const; | ||
| 110 | |||
| 111 | boost::optional<ScheduleDay> humidityConditionDaySchedule() const; | ||
| 112 | |||
| 113 | boost::optional<double> wetBulbOrDewPointAtMaximumDryBulb() const; | ||
| 114 | |||
| 115 | boost::optional<double> humidityRatioAtMaximumDryBulb() const; | ||
| 116 | |||
| 117 | boost::optional<double> enthalpyAtMaximumDryBulb() const; | ||
| 118 | |||
| 119 | std::string dryBulbTemperatureRangeModifierType() const; | ||
| 120 | |||
| 121 | bool isDryBulbTemperatureRangeModifierTypeDefaulted() const; | ||
| 122 | |||
| 123 | OS_DEPRECATED(3, 3, 0) boost::optional<ScheduleDay> dryBulbTemperatureRangeModifierSchedule() const; | ||
| 124 | |||
| 125 | boost::optional<ScheduleDay> dryBulbTemperatureRangeModifierDaySchedule() const; | ||
| 126 | |||
| 127 | std::string solarModelIndicator() const; | ||
| 128 | |||
| 129 | bool isSolarModelIndicatorDefaulted() const; | ||
| 130 | |||
| 131 | boost::optional<ScheduleDay> beamSolarDaySchedule() const; | ||
| 132 | |||
| 133 | boost::optional<ScheduleDay> diffuseSolarDaySchedule() const; | ||
| 134 | |||
| 135 | OS_DEPRECATED(3, 3, 0) double ashraeTaub() const; | ||
| 136 | |||
| 137 | double ashraeClearSkyOpticalDepthForBeamIrradiance() const; | ||
| 138 | |||
| 139 | OS_DEPRECATED(3, 3, 0) bool isAshraeTaubDefaulted() const; | ||
| 140 | |||
| 141 | bool isAshraeClearSkyOpticalDepthForBeamIrradianceDefaulted() const; | ||
| 142 | |||
| 143 | OS_DEPRECATED(3, 3, 0) double ashraeTaud() const; | ||
| 144 | |||
| 145 | double ashraeClearSkyOpticalDepthForDiffuseIrradiance() const; | ||
| 146 | |||
| 147 | OS_DEPRECATED(3, 3, 0) bool isAshraeTaudDefaulted() const; | ||
| 148 | |||
| 149 | bool isAshraeClearSkyOpticalDepthForDiffuseIrradianceDefaulted() const; | ||
| 150 | |||
| 151 | boost::optional<double> dailyWetBulbTemperatureRange() const; | ||
| 152 | |||
| 153 | boost::optional<int> maximumNumberWarmupDays() const; | ||
| 154 | |||
| 155 | std::string beginEnvironmentResetMode() const; | ||
| 156 | |||
| 157 | bool isBeginEnvironmentResetModeDefaulted() const; | ||
| 158 | |||
| 159 | //@} | ||
| 160 | /** @name Setters */ | ||
| 161 | //@{ | ||
| 162 | |||
| 163 | bool setMaximumDryBulbTemperature(double maximumDryBulbTemperature); | ||
| 164 | |||
| 165 | void resetMaximumDryBulbTemperature(); | ||
| 166 | |||
| 167 | bool setDailyDryBulbTemperatureRange(double dailyDryBulbTemperatureRange); | ||
| 168 | |||
| 169 | void resetDailyDryBulbTemperatureRange(); | ||
| 170 | |||
| 171 | bool setBarometricPressure(double barometricPressure); | ||
| 172 | |||
| 173 | void resetBarometricPressure(); | ||
| 174 | |||
| 175 | bool setWindSpeed(double windSpeed); | ||
| 176 | |||
| 177 | void resetWindSpeed(); | ||
| 178 | |||
| 179 | bool setWindDirection(double windDirection); | ||
| 180 | |||
| 181 | void resetWindDirection(); | ||
| 182 | |||
| 183 | bool setSkyClearness(double skyClearness); | ||
| 184 | |||
| 185 | void resetSkyClearness(); | ||
| 186 | |||
| 187 | bool setRainIndicator(bool rainIndicator); | ||
| 188 | |||
| 189 | void resetRainIndicator(); | ||
| 190 | |||
| 191 | bool setSnowIndicator(bool snowIndicator); | ||
| 192 | |||
| 193 | void resetSnowIndicator(); | ||
| 194 | |||
| 195 | bool setDayOfMonth(int dayOfMonth); | ||
| 196 | |||
| 197 | void resetDayOfMonth(); | ||
| 198 | |||
| 199 | bool setMonth(int month); | ||
| 200 | |||
| 201 | void resetMonth(); | ||
| 202 | |||
| 203 | bool setDayType(const std::string& dayType); | ||
| 204 | |||
| 205 | void resetDayType(); | ||
| 206 | |||
| 207 | bool setDaylightSavingTimeIndicator(bool daylightSavingTimeIndicator); | ||
| 208 | |||
| 209 | void resetDaylightSavingTimeIndicator(); | ||
| 210 | |||
| 211 | OS_DEPRECATED(3, 3, 0) bool setHumidityIndicatingType(const std::string& humidityIndicatingType); | ||
| 212 | |||
| 213 | bool setHumidityConditionType(const std::string& humidityConditionType); | ||
| 214 | |||
| 215 | OS_DEPRECATED(3, 3, 0) void resetHumidityIndicatingType(); | ||
| 216 | |||
| 217 | void resetHumidityConditionType(); | ||
| 218 | |||
| 219 | /** Sets the humidity indicating day schedule. The appropriate ScheduleTypeLimits varies | ||
| 220 | * depending on the humidity indicating type. Please see the EnergyPlus input-output reference | ||
| 221 | * for details before using this feature. */ | ||
| 222 | OS_DEPRECATED(3, 3, 0) bool setHumidityIndicatingDaySchedule(const ScheduleDay& schedule); | ||
| 223 | |||
| 224 | bool setHumidityConditionDaySchedule(const ScheduleDay& schedule); | ||
| 225 | |||
| 226 | OS_DEPRECATED(3, 3, 0) void resetHumidityIndicatingDaySchedule(); | ||
| 227 | |||
| 228 | void resetHumidityConditionDaySchedule(); | ||
| 229 | |||
| 230 | OS_DEPRECATED(3, 3, 0) bool setHumidityIndicatingConditionsAtMaximumDryBulb(double humidityIndicatingConditionsAtMaximumDryBulb); | ||
| 231 | |||
| 232 | OS_DEPRECATED(3, 3, 0) void resetHumidityIndicatingConditionsAtMaximumDryBulb(); | ||
| 233 | |||
| 234 | bool setWetBulbOrDewPointAtMaximumDryBulb(double wetBulbOrDewPointAtMaximumDryBulb); | ||
| 235 | |||
| 236 | void resetWetBulbOrDewPointAtMaximumDryBulb(); | ||
| 237 | |||
| 238 | bool setHumidityRatioAtMaximumDryBulb(double humidityRatioAtMaximumDryBulb); | ||
| 239 | |||
| 240 | void resetHumidityRatioAtMaximumDryBulb(); | ||
| 241 | |||
| 242 | bool setEnthalpyAtMaximumDryBulb(double enthalpyAtMaximumDryBulb); | ||
| 243 | |||
| 244 | void resetEnthalpyAtMaximumDryBulb(); | ||
| 245 | |||
| 246 | bool setDryBulbTemperatureRangeModifierType(const std::string& dryBulbTemperatureRangeModifierType); | ||
| 247 | |||
| 248 | void resetDryBulbTemperatureRangeModifierType(); | ||
| 249 | |||
| 250 | /** Sets the dry bulb temperature range modifier day schedule. The appropriate | ||
| 251 | * ScheduleTypeLimits varies depending on the dry bulb temperature range modifier type. Please | ||
| 252 | * see the EnergyPlus input-output reference for details before using this feature. */ | ||
| 253 | OS_DEPRECATED(3, 3, 0) bool setDryBulbTemperatureRangeModifierSchedule(const ScheduleDay& schedule); | ||
| 254 | |||
| 255 | bool setDryBulbTemperatureRangeModifierDaySchedule(const ScheduleDay& schedule); | ||
| 256 | |||
| 257 | OS_DEPRECATED(3, 3, 0) void resetDryBulbTemperatureRangeModifierSchedule(); | ||
| 258 | |||
| 259 | void resetDryBulbTemperatureRangeModifierDaySchedule(); | ||
| 260 | |||
| 261 | bool setSolarModelIndicator(const std::string& solarModelIndicator); | ||
| 262 | |||
| 263 | void resetSolarModelIndicator(); | ||
| 264 | |||
| 265 | bool setBeamSolarDaySchedule(const ScheduleDay& schedule); | ||
| 266 | |||
| 267 | void resetBeamSolarDaySchedule(); | ||
| 268 | |||
| 269 | bool setDiffuseSolarDaySchedule(const ScheduleDay& schedule); | ||
| 270 | |||
| 271 | void resetDiffuseSolarDaySchedule(); | ||
| 272 | |||
| 273 | OS_DEPRECATED(3, 3, 0) bool setAshraeTaub(double ashraeTaub); | ||
| 274 | |||
| 275 | bool setAshraeClearSkyOpticalDepthForBeamIrradiance(double ashraeClearSkyOpticalDepthForBeamIrradiance); | ||
| 276 | |||
| 277 | OS_DEPRECATED(3, 3, 0) void resetAshraeTaub(); | ||
| 278 | |||
| 279 | void resetAshraeClearSkyOpticalDepthForBeamIrradiance(); | ||
| 280 | |||
| 281 | OS_DEPRECATED(3, 3, 0) bool setAshraeTaud(double ashraeTaud); | ||
| 282 | |||
| 283 | bool setAshraeClearSkyOpticalDepthForDiffuseIrradiance(double ashraeClearSkyOpticalDepthForDiffuseIrradiance); | ||
| 284 | |||
| 285 | OS_DEPRECATED(3, 3, 0) void resetAshraeTaud(); | ||
| 286 | |||
| 287 | void resetAshraeClearSkyOpticalDepthForDiffuseIrradiance(); | ||
| 288 | |||
| 289 | bool setDailyWetBulbTemperatureRange(double dailyWetBulbTemperatureRange); | ||
| 290 | |||
| 291 | void resetDailyWetBulbTemperatureRange(); | ||
| 292 | |||
| 293 | bool setMaximumNumberWarmupDays(int maximumNumberWarmupDays); | ||
| 294 | |||
| 295 | void resetMaximumNumberWarmupDays(); | ||
| 296 | |||
| 297 | bool setBeginEnvironmentResetMode(const std::string& beginEnvironmentResetMode); | ||
| 298 | |||
| 299 | void resetBeginEnvironmentResetMode(); | ||
| 300 | |||
| 301 | //@} | ||
| 302 | |||
| 303 | 573 | virtual ~DesignDay() override = default; | |
| 304 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 305 | 5 | DesignDay(const DesignDay& other) = default; | |
| 306 | 12 | DesignDay(DesignDay&& other) = default; | |
| 307 | 2 | DesignDay& operator=(const DesignDay&) = default; | |
| 308 | 1 | DesignDay& operator=(DesignDay&&) = default; | |
| 309 | |||
| 310 | protected: | ||
| 311 | friend class Model; | ||
| 312 | |||
| 313 | friend class openstudio::IdfObject; | ||
| 314 | |||
| 315 | using ImplType = detail::DesignDay_Impl; | ||
| 316 | |||
| 317 | // constructor | ||
| 318 | explicit DesignDay(std::shared_ptr<detail::DesignDay_Impl> impl); | ||
| 319 | |||
| 320 | private: | ||
| 321 | − | REGISTER_LOGGER("openstudio.model.DesignDay"); | |
| 322 | }; | ||
| 323 | |||
| 324 | /** \relates DesignDay */ | ||
| 325 | using OptionalDesignDay = boost::optional<DesignDay>; | ||
| 326 | |||
| 327 | /** \relates DesignDay */ | ||
| 328 | using DesignDayVector = std::vector<DesignDay>; | ||
| 329 | |||
| 330 | } // namespace model | ||
| 331 | } // namespace openstudio | ||
| 332 | |||
| 333 | #endif // MODEL_DESIGNDAY_HPP | ||
| 334 |