src/model/RefrigerationCase_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_REFRIGERATIONCASE_IMPL_HPP | ||
| 7 | #define MODEL_REFRIGERATIONCASE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | class Time; | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class RefrigerationSystem; | ||
| 19 | class RefrigerationSecondarySystem; | ||
| 20 | class RefrigerationCompressorRack; | ||
| 21 | class Schedule; | ||
| 22 | class ThermalZone; | ||
| 23 | class CurveCubic; | ||
| 24 | class RefrigerationDefrostCycleParameters; | ||
| 25 | |||
| 26 | namespace detail { | ||
| 27 | |||
| 28 | /** RefrigerationCase_Impl is a ParentObject_Impl that is the implementation class for RefrigerationCase.*/ | ||
| 29 | class MODEL_API RefrigerationCase_Impl : public ParentObject_Impl | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | RefrigerationCase_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | RefrigerationCase_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 38 | |||
| 39 | RefrigerationCase_Impl(const RefrigerationCase_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 40 | |||
| 41 | 111 | virtual ~RefrigerationCase_Impl() override = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | /** @name Virtual Methods */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 48 | |||
| 49 | virtual IddObjectType iddObjectType() const override; | ||
| 50 | |||
| 51 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 52 | |||
| 53 | virtual ModelObject clone(Model model) const override; | ||
| 54 | |||
| 55 | virtual std::vector<IdfObject> remove() override; | ||
| 56 | |||
| 57 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 58 | |||
| 59 | virtual std::vector<ModelObject> children() const override; | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Getters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 66 | |||
| 67 | boost::optional<ThermalZone> thermalZone() const; | ||
| 68 | |||
| 69 | double ratedAmbientTemperature() const; | ||
| 70 | |||
| 71 | bool isRatedAmbientTemperatureDefaulted() const; | ||
| 72 | |||
| 73 | double ratedAmbientRelativeHumidity() const; | ||
| 74 | |||
| 75 | bool isRatedAmbientRelativeHumidityDefaulted() const; | ||
| 76 | |||
| 77 | double ratedTotalCoolingCapacityperUnitLength() const; | ||
| 78 | |||
| 79 | bool isRatedTotalCoolingCapacityperUnitLengthDefaulted() const; | ||
| 80 | |||
| 81 | double ratedLatentHeatRatio() const; | ||
| 82 | |||
| 83 | bool isRatedLatentHeatRatioDefaulted() const; | ||
| 84 | |||
| 85 | double ratedRuntimeFraction() const; | ||
| 86 | |||
| 87 | bool isRatedRuntimeFractionDefaulted() const; | ||
| 88 | |||
| 89 | double caseLength() const; | ||
| 90 | |||
| 91 | bool isCaseLengthDefaulted() const; | ||
| 92 | |||
| 93 | double caseOperatingTemperature() const; | ||
| 94 | |||
| 95 | bool isCaseOperatingTemperatureDefaulted() const; | ||
| 96 | |||
| 97 | std::string latentCaseCreditCurveType() const; | ||
| 98 | |||
| 99 | bool isLatentCaseCreditCurveTypeDefaulted() const; | ||
| 100 | |||
| 101 | CurveCubic latentCaseCreditCurve() const; | ||
| 102 | |||
| 103 | double standardCaseFanPowerperUnitLength() const; | ||
| 104 | |||
| 105 | bool isStandardCaseFanPowerperUnitLengthDefaulted() const; | ||
| 106 | |||
| 107 | double operatingCaseFanPowerperUnitLength() const; | ||
| 108 | |||
| 109 | bool isOperatingCaseFanPowerperUnitLengthDefaulted() const; | ||
| 110 | |||
| 111 | double standardCaseLightingPowerperUnitLength() const; | ||
| 112 | |||
| 113 | bool isStandardCaseLightingPowerperUnitLengthDefaulted() const; | ||
| 114 | |||
| 115 | boost::optional<double> installedCaseLightingPowerperUnitLength() const; | ||
| 116 | |||
| 117 | boost::optional<Schedule> caseLightingSchedule() const; | ||
| 118 | |||
| 119 | double fractionofLightingEnergytoCase() const; | ||
| 120 | |||
| 121 | bool isFractionofLightingEnergytoCaseDefaulted() const; | ||
| 122 | |||
| 123 | double caseAntiSweatHeaterPowerperUnitLength() const; | ||
| 124 | |||
| 125 | bool isCaseAntiSweatHeaterPowerperUnitLengthDefaulted() const; | ||
| 126 | |||
| 127 | double minimumAntiSweatHeaterPowerperUnitLength() const; | ||
| 128 | |||
| 129 | bool isMinimumAntiSweatHeaterPowerperUnitLengthDefaulted() const; | ||
| 130 | |||
| 131 | std::string antiSweatHeaterControlType() const; | ||
| 132 | |||
| 133 | bool isAntiSweatHeaterControlTypeDefaulted() const; | ||
| 134 | |||
| 135 | double humidityatZeroAntiSweatHeaterEnergy() const; | ||
| 136 | |||
| 137 | bool isHumidityatZeroAntiSweatHeaterEnergyDefaulted() const; | ||
| 138 | |||
| 139 | double caseHeight() const; | ||
| 140 | |||
| 141 | bool isCaseHeightDefaulted() const; | ||
| 142 | |||
| 143 | double fractionofAntiSweatHeaterEnergytoCase() const; | ||
| 144 | |||
| 145 | bool isFractionofAntiSweatHeaterEnergytoCaseDefaulted() const; | ||
| 146 | |||
| 147 | double caseDefrostPowerperUnitLength() const; | ||
| 148 | |||
| 149 | bool isCaseDefrostPowerperUnitLengthDefaulted() const; | ||
| 150 | |||
| 151 | std::string caseDefrostType() const; | ||
| 152 | |||
| 153 | bool isCaseDefrostTypeDefaulted() const; | ||
| 154 | |||
| 155 | boost::optional<Schedule> caseDefrostSchedule() const; | ||
| 156 | |||
| 157 | boost::optional<Schedule> caseDefrostDripDownSchedule() const; | ||
| 158 | |||
| 159 | std::string defrostEnergyCorrectionCurveType() const; | ||
| 160 | |||
| 161 | bool isDefrostEnergyCorrectionCurveTypeDefaulted() const; | ||
| 162 | |||
| 163 | boost::optional<CurveCubic> defrostEnergyCorrectionCurve() const; | ||
| 164 | |||
| 165 | double underCaseHVACReturnAirFraction() const; | ||
| 166 | |||
| 167 | bool isUnderCaseHVACReturnAirFractionDefaulted() const; | ||
| 168 | |||
| 169 | boost::optional<Schedule> refrigeratedCaseRestockingSchedule() const; | ||
| 170 | |||
| 171 | boost::optional<Schedule> caseCreditFractionSchedule() const; | ||
| 172 | |||
| 173 | boost::optional<double> designEvaporatorTemperatureorBrineInletTemperature() const; | ||
| 174 | |||
| 175 | double averageRefrigerantChargeInventory() const; | ||
| 176 | |||
| 177 | bool isAverageRefrigerantChargeInventoryDefaulted() const; | ||
| 178 | |||
| 179 | boost::optional<int> numberOfDoors() const; | ||
| 180 | |||
| 181 | boost::optional<double> ratedTotalCoolingCapacityperDoor() const; | ||
| 182 | |||
| 183 | boost::optional<double> standardCaseFanPowerperDoor() const; | ||
| 184 | |||
| 185 | boost::optional<double> operatingCaseFanPowerperDoor() const; | ||
| 186 | |||
| 187 | boost::optional<double> standardCaseLightingPowerperDoor() const; | ||
| 188 | |||
| 189 | boost::optional<double> installedCaseLightingPowerperDoor() const; | ||
| 190 | |||
| 191 | boost::optional<double> caseAntiSweatHeaterPowerperDoor() const; | ||
| 192 | |||
| 193 | boost::optional<double> minimumAntiSweatHeaterPowerperDoor() const; | ||
| 194 | |||
| 195 | boost::optional<double> caseDefrostPowerperDoor() const; | ||
| 196 | |||
| 197 | std::string unitType() const; | ||
| 198 | |||
| 199 | bool isUnitTypeDefaulted() const; | ||
| 200 | |||
| 201 | boost::optional<RefrigerationDefrostCycleParameters> optionalCaseDefrostCycleParameters() const; | ||
| 202 | |||
| 203 | RefrigerationDefrostCycleParameters caseDefrostCycleParameters(); | ||
| 204 | |||
| 205 | boost::optional<int> durationofDefrostCycle() const; | ||
| 206 | |||
| 207 | boost::optional<int> dripDownTime() const; | ||
| 208 | |||
| 209 | boost::optional<openstudio::Time> defrost1StartTime() const; | ||
| 210 | |||
| 211 | boost::optional<openstudio::Time> defrost2StartTime() const; | ||
| 212 | |||
| 213 | boost::optional<openstudio::Time> defrost3StartTime() const; | ||
| 214 | |||
| 215 | boost::optional<openstudio::Time> defrost4StartTime() const; | ||
| 216 | |||
| 217 | boost::optional<openstudio::Time> defrost5StartTime() const; | ||
| 218 | |||
| 219 | boost::optional<openstudio::Time> defrost6StartTime() const; | ||
| 220 | |||
| 221 | boost::optional<openstudio::Time> defrost7StartTime() const; | ||
| 222 | |||
| 223 | boost::optional<openstudio::Time> defrost8StartTime() const; | ||
| 224 | |||
| 225 | std::vector<openstudio::Time> defrostStartTimes() const; | ||
| 226 | |||
| 227 | boost::optional<RefrigerationSystem> system() const; | ||
| 228 | |||
| 229 | boost::optional<RefrigerationSecondarySystem> secondarySystem() const; | ||
| 230 | |||
| 231 | boost::optional<RefrigerationCompressorRack> compressorRack() const; | ||
| 232 | |||
| 233 | //@} | ||
| 234 | /** @name Setters */ | ||
| 235 | //@{ | ||
| 236 | |||
| 237 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 238 | |||
| 239 | void resetAvailabilitySchedule(); | ||
| 240 | |||
| 241 | bool setThermalZone(const ThermalZone& thermalZone); | ||
| 242 | |||
| 243 | void resetThermalZone(); | ||
| 244 | |||
| 245 | bool setRatedAmbientTemperature(double ratedAmbientTemperature); | ||
| 246 | |||
| 247 | void resetRatedAmbientTemperature(); | ||
| 248 | |||
| 249 | bool setRatedAmbientRelativeHumidity(double ratedAmbientRelativeHumidity); | ||
| 250 | |||
| 251 | void resetRatedAmbientRelativeHumidity(); | ||
| 252 | |||
| 253 | bool setRatedTotalCoolingCapacityperUnitLength(double ratedTotalCoolingCapacityperUnitLength); | ||
| 254 | |||
| 255 | void resetRatedTotalCoolingCapacityperUnitLength(); | ||
| 256 | |||
| 257 | bool setRatedLatentHeatRatio(double ratedLatentHeatRatio); | ||
| 258 | |||
| 259 | void resetRatedLatentHeatRatio(); | ||
| 260 | |||
| 261 | bool setRatedRuntimeFraction(double ratedRuntimeFraction); | ||
| 262 | |||
| 263 | void resetRatedRuntimeFraction(); | ||
| 264 | |||
| 265 | bool setCaseLength(double caseLength); | ||
| 266 | |||
| 267 | void resetCaseLength(); | ||
| 268 | |||
| 269 | bool setCaseOperatingTemperature(double caseOperatingTemperature); | ||
| 270 | |||
| 271 | void resetCaseOperatingTemperature(); | ||
| 272 | |||
| 273 | bool setLatentCaseCreditCurveType(const std::string& latentCaseCreditCurveType); | ||
| 274 | |||
| 275 | void resetLatentCaseCreditCurveType(); | ||
| 276 | |||
| 277 | bool setLatentCaseCreditCurve(const CurveCubic& curveCubic); | ||
| 278 | |||
| 279 | bool setStandardCaseFanPowerperUnitLength(double standardCaseFanPowerperUnitLength); | ||
| 280 | |||
| 281 | void resetStandardCaseFanPowerperUnitLength(); | ||
| 282 | |||
| 283 | bool setOperatingCaseFanPowerperUnitLength(double operatingCaseFanPowerperUnitLength); | ||
| 284 | |||
| 285 | void resetOperatingCaseFanPowerperUnitLength(); | ||
| 286 | |||
| 287 | bool setStandardCaseLightingPowerperUnitLength(double standardCaseLightingPowerperUnitLength); | ||
| 288 | |||
| 289 | void resetStandardCaseLightingPowerperUnitLength(); | ||
| 290 | |||
| 291 | bool setInstalledCaseLightingPowerperUnitLength(boost::optional<double> installedCaseLightingPowerperUnitLength); | ||
| 292 | |||
| 293 | void resetInstalledCaseLightingPowerperUnitLength(); | ||
| 294 | |||
| 295 | bool setCaseLightingSchedule(Schedule& schedule); | ||
| 296 | |||
| 297 | void resetCaseLightingSchedule(); | ||
| 298 | |||
| 299 | bool setFractionofLightingEnergytoCase(double fractionofLightingEnergytoCase); | ||
| 300 | |||
| 301 | void resetFractionofLightingEnergytoCase(); | ||
| 302 | |||
| 303 | bool setCaseAntiSweatHeaterPowerperUnitLength(double caseAntiSweatHeaterPowerperUnitLength); | ||
| 304 | |||
| 305 | void resetCaseAntiSweatHeaterPowerperUnitLength(); | ||
| 306 | |||
| 307 | bool setMinimumAntiSweatHeaterPowerperUnitLength(double minimumAntiSweatHeaterPowerperUnitLength); | ||
| 308 | |||
| 309 | void resetMinimumAntiSweatHeaterPowerperUnitLength(); | ||
| 310 | |||
| 311 | bool setAntiSweatHeaterControlType(const std::string& antiSweatHeaterControlType); | ||
| 312 | |||
| 313 | void resetAntiSweatHeaterControlType(); | ||
| 314 | |||
| 315 | bool setHumidityatZeroAntiSweatHeaterEnergy(double humidityatZeroAntiSweatHeaterEnergy); | ||
| 316 | |||
| 317 | void resetHumidityatZeroAntiSweatHeaterEnergy(); | ||
| 318 | |||
| 319 | bool setCaseHeight(double caseHeight); | ||
| 320 | |||
| 321 | void resetCaseHeight(); | ||
| 322 | |||
| 323 | bool setFractionofAntiSweatHeaterEnergytoCase(double fractionofAntiSweatHeaterEnergytoCase); | ||
| 324 | |||
| 325 | void resetFractionofAntiSweatHeaterEnergytoCase(); | ||
| 326 | |||
| 327 | bool setCaseDefrostPowerperUnitLength(double caseDefrostPowerperUnitLength); | ||
| 328 | |||
| 329 | void resetCaseDefrostPowerperUnitLength(); | ||
| 330 | |||
| 331 | bool setCaseDefrostType(const std::string& caseDefrostType); | ||
| 332 | |||
| 333 | void resetCaseDefrostType(); | ||
| 334 | |||
| 335 | bool setCaseDefrostSchedule(Schedule& schedule); | ||
| 336 | |||
| 337 | void resetCaseDefrostSchedule(); | ||
| 338 | |||
| 339 | bool setCaseDefrostDripDownSchedule(Schedule& schedule); | ||
| 340 | |||
| 341 | void resetCaseDefrostDripDownSchedule(); | ||
| 342 | |||
| 343 | bool setDefrostEnergyCorrectionCurveType(const std::string& defrostEnergyCorrectionCurveType); | ||
| 344 | |||
| 345 | void resetDefrostEnergyCorrectionCurveType(); | ||
| 346 | |||
| 347 | bool setDefrostEnergyCorrectionCurve(const boost::optional<CurveCubic>& curveCubic); | ||
| 348 | |||
| 349 | void resetDefrostEnergyCorrectionCurve(); | ||
| 350 | |||
| 351 | bool setUnderCaseHVACReturnAirFraction(double underCaseHVACReturnAirFraction); | ||
| 352 | |||
| 353 | void resetUnderCaseHVACReturnAirFraction(); | ||
| 354 | |||
| 355 | bool setRefrigeratedCaseRestockingSchedule(Schedule& schedule); | ||
| 356 | |||
| 357 | void resetRefrigeratedCaseRestockingSchedule(); | ||
| 358 | |||
| 359 | bool setCaseCreditFractionSchedule(Schedule& schedule); | ||
| 360 | |||
| 361 | void resetCaseCreditFractionSchedule(); | ||
| 362 | |||
| 363 | bool setDesignEvaporatorTemperatureorBrineInletTemperature(boost::optional<double> designEvaporatorTemperatureorBrineInletTemperature); | ||
| 364 | |||
| 365 | void resetDesignEvaporatorTemperatureorBrineInletTemperature(); | ||
| 366 | |||
| 367 | bool setAverageRefrigerantChargeInventory(double averageRefrigerantChargeInventory); | ||
| 368 | |||
| 369 | void resetAverageRefrigerantChargeInventory(); | ||
| 370 | |||
| 371 | bool setNumberOfDoors(boost::optional<int> numberOfDoors); | ||
| 372 | |||
| 373 | void resetNumberOfDoors(); | ||
| 374 | |||
| 375 | bool setRatedTotalCoolingCapacityperDoor(boost::optional<double> ratedTotalCoolingCapacityperDoor); | ||
| 376 | |||
| 377 | void resetRatedTotalCoolingCapacityperDoor(); | ||
| 378 | |||
| 379 | bool setStandardCaseFanPowerperDoor(boost::optional<double> standardCaseFanPowerperDoor); | ||
| 380 | |||
| 381 | void resetStandardCaseFanPowerperDoor(); | ||
| 382 | |||
| 383 | bool setOperatingCaseFanPowerperDoor(boost::optional<double> operatingCaseFanPowerperDoor); | ||
| 384 | |||
| 385 | void resetOperatingCaseFanPowerperDoor(); | ||
| 386 | |||
| 387 | bool setStandardCaseLightingPowerperDoor(boost::optional<double> standardCaseLightingPowerperDoor); | ||
| 388 | |||
| 389 | void resetStandardCaseLightingPowerperDoor(); | ||
| 390 | |||
| 391 | bool setInstalledCaseLightingPowerperDoor(boost::optional<double> installedCaseLightingPowerperDoor); | ||
| 392 | |||
| 393 | void resetInstalledCaseLightingPowerperDoor(); | ||
| 394 | |||
| 395 | bool setCaseAntiSweatHeaterPowerperDoor(boost::optional<double> caseAntiSweatHeaterPowerperDoor); | ||
| 396 | |||
| 397 | void resetCaseAntiSweatHeaterPowerperDoor(); | ||
| 398 | |||
| 399 | bool setMinimumAntiSweatHeaterPowerperDoor(boost::optional<double> minimumAntiSweatHeaterPowerperDoor); | ||
| 400 | |||
| 401 | void resetMinimumAntiSweatHeaterPowerperDoor(); | ||
| 402 | |||
| 403 | bool setCaseDefrostPowerperDoor(boost::optional<double> caseDefrostPowerperDoor); | ||
| 404 | |||
| 405 | void resetCaseDefrostPowerperDoor(); | ||
| 406 | |||
| 407 | bool setUnitType(const std::string& unitType); | ||
| 408 | |||
| 409 | void resetUnitType(); | ||
| 410 | |||
| 411 | bool setCaseDefrostCycleParameters(const RefrigerationDefrostCycleParameters& caseDefrostCycleParameters); | ||
| 412 | |||
| 413 | bool setDurationofDefrostCycle(boost::optional<int> durationofDefrostCycle); | ||
| 414 | |||
| 415 | void resetDurationofDefrostCycle(); | ||
| 416 | |||
| 417 | bool setDripDownTime(boost::optional<int> dripDownTime); | ||
| 418 | |||
| 419 | void resetDripDownTime(); | ||
| 420 | |||
| 421 | bool setDefrost1StartTime(const openstudio::Time& defrost1StartTime); | ||
| 422 | |||
| 423 | void resetDefrost1StartTime(); | ||
| 424 | |||
| 425 | bool setDefrost2StartTime(const openstudio::Time& defrost2StartTime); | ||
| 426 | |||
| 427 | void resetDefrost2StartTime(); | ||
| 428 | |||
| 429 | bool setDefrost3StartTime(const openstudio::Time& defrost3StartTime); | ||
| 430 | |||
| 431 | void resetDefrost3StartTime(); | ||
| 432 | |||
| 433 | bool setDefrost4StartTime(const openstudio::Time& defrost4StartTime); | ||
| 434 | |||
| 435 | void resetDefrost4StartTime(); | ||
| 436 | |||
| 437 | bool setDefrost5StartTime(const openstudio::Time& defrost5StartTime); | ||
| 438 | |||
| 439 | void resetDefrost5StartTime(); | ||
| 440 | |||
| 441 | bool setDefrost6StartTime(const openstudio::Time& defrost6StartTime); | ||
| 442 | |||
| 443 | void resetDefrost6StartTime(); | ||
| 444 | |||
| 445 | bool setDefrost7StartTime(const openstudio::Time& defrost7StartTime); | ||
| 446 | |||
| 447 | void resetDefrost7StartTime(); | ||
| 448 | |||
| 449 | bool setDefrost8StartTime(const openstudio::Time& defrost8StartTime); | ||
| 450 | |||
| 451 | void resetDefrost8StartTime(); | ||
| 452 | |||
| 453 | bool addToSystem(RefrigerationSystem& system); | ||
| 454 | |||
| 455 | void removeFromSystem(); | ||
| 456 | |||
| 457 | bool addToSecondarySystem(RefrigerationSecondarySystem& secondarySystem); | ||
| 458 | |||
| 459 | void removeFromSecondarySystem(); | ||
| 460 | |||
| 461 | bool addToCompressorRack(RefrigerationCompressorRack& compressorRack); | ||
| 462 | |||
| 463 | void removeFromCompressorRack(); | ||
| 464 | |||
| 465 | //@} | ||
| 466 | /** @name Other */ | ||
| 467 | //@{ | ||
| 468 | |||
| 469 | //@} | ||
| 470 | protected: | ||
| 471 | private: | ||
| 472 | − | REGISTER_LOGGER("openstudio.model.RefrigerationCase"); | |
| 473 | |||
| 474 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 475 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 476 | // objects should be returned as boost::optionals | ||
| 477 | boost::optional<CurveCubic> optionalLatentCaseCreditCurve() const; | ||
| 478 | }; | ||
| 479 | |||
| 480 | } // namespace detail | ||
| 481 | |||
| 482 | } // namespace model | ||
| 483 | } // namespace openstudio | ||
| 484 | |||
| 485 | #endif // MODEL_REFRIGERATIONCASE_IMPL_HPP | ||
| 486 |