src/model/RefrigerationWalkIn_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_REFRIGERATIONWALKIN_IMPL_HPP | ||
| 7 | #define MODEL_REFRIGERATIONWALKIN_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | #include "RefrigerationWalkInZoneBoundary.hpp" | ||
| 12 | #include "ThermalZone.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | class Time; | ||
| 17 | |||
| 18 | namespace model { | ||
| 19 | |||
| 20 | class Schedule; | ||
| 21 | class RefrigerationSystem; | ||
| 22 | class RefrigerationSecondarySystem; | ||
| 23 | class RefrigerationCompressorRack; | ||
| 24 | class RefrigerationWalkInZoneBoundary; | ||
| 25 | class RefrigerationDefrostCycleParameters; | ||
| 26 | |||
| 27 | namespace detail { | ||
| 28 | |||
| 29 | /** RefrigerationWalkIn_Impl is a ModelObject_Impl that is the implementation class for RefrigerationWalkIn.*/ | ||
| 30 | class MODEL_API RefrigerationWalkIn_Impl : public ModelObject_Impl | ||
| 31 | { | ||
| 32 | public: | ||
| 33 | /** @name Constructors and Destructors */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | RefrigerationWalkIn_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 37 | |||
| 38 | RefrigerationWalkIn_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 39 | |||
| 40 | RefrigerationWalkIn_Impl(const RefrigerationWalkIn_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 41 | |||
| 42 | 90 | virtual ~RefrigerationWalkIn_Impl() override = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | /** @name Virtual Methods */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 49 | |||
| 50 | virtual IddObjectType iddObjectType() const override; | ||
| 51 | |||
| 52 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 53 | |||
| 54 | virtual ModelObject clone(Model model) const override; | ||
| 55 | |||
| 56 | virtual std::vector<IdfObject> remove() override; | ||
| 57 | |||
| 58 | bool addZoneBoundary(const RefrigerationWalkInZoneBoundary& refrigerationWalkInZoneBoundary); | ||
| 59 | |||
| 60 | void removeZoneBoundary(unsigned index); | ||
| 61 | |||
| 62 | void removeAllZoneBoundaries(); | ||
| 63 | |||
| 64 | std::vector<RefrigerationWalkInZoneBoundary> zoneBoundaries() const; | ||
| 65 | |||
| 66 | //@} | ||
| 67 | /** @name Getters */ | ||
| 68 | //@{ | ||
| 69 | |||
| 70 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 71 | |||
| 72 | double ratedCoilCoolingCapacity() const; | ||
| 73 | |||
| 74 | double operatingTemperature() const; | ||
| 75 | |||
| 76 | double ratedCoolingSourceTemperature() const; | ||
| 77 | |||
| 78 | double ratedTotalHeatingPower() const; | ||
| 79 | |||
| 80 | boost::optional<Schedule> heatingPowerSchedule() const; | ||
| 81 | |||
| 82 | double ratedCoolingCoilFanPower() const; | ||
| 83 | |||
| 84 | bool isRatedCoolingCoilFanPowerDefaulted() const; | ||
| 85 | |||
| 86 | double ratedCirculationFanPower() const; | ||
| 87 | |||
| 88 | bool isRatedCirculationFanPowerDefaulted() const; | ||
| 89 | |||
| 90 | double ratedTotalLightingPower() const; | ||
| 91 | |||
| 92 | boost::optional<Schedule> lightingSchedule() const; | ||
| 93 | |||
| 94 | std::string defrostType() const; | ||
| 95 | |||
| 96 | bool isDefrostTypeDefaulted() const; | ||
| 97 | |||
| 98 | std::string defrostControlType() const; | ||
| 99 | |||
| 100 | bool isDefrostControlTypeDefaulted() const; | ||
| 101 | |||
| 102 | Schedule defrostSchedule() const; | ||
| 103 | |||
| 104 | boost::optional<Schedule> defrostDripDownSchedule() const; | ||
| 105 | |||
| 106 | boost::optional<double> defrostPower() const; | ||
| 107 | |||
| 108 | boost::optional<double> temperatureTerminationDefrostFractiontoIce() const; | ||
| 109 | |||
| 110 | boost::optional<Schedule> restockingSchedule() const; | ||
| 111 | |||
| 112 | double averageRefrigerantChargeInventory() const; | ||
| 113 | |||
| 114 | bool isAverageRefrigerantChargeInventoryDefaulted() const; | ||
| 115 | |||
| 116 | double insulatedFloorSurfaceArea() const; | ||
| 117 | |||
| 118 | double insulatedFloorUValue() const; | ||
| 119 | |||
| 120 | bool isInsulatedFloorUValueDefaulted() const; | ||
| 121 | |||
| 122 | boost::optional<RefrigerationDefrostCycleParameters> optionalWalkinDefrostCycleParameters() const; | ||
| 123 | |||
| 124 | RefrigerationDefrostCycleParameters walkinDefrostCycleParameters(); | ||
| 125 | |||
| 126 | boost::optional<int> durationofDefrostCycle() const; | ||
| 127 | |||
| 128 | boost::optional<int> dripDownTime() const; | ||
| 129 | |||
| 130 | boost::optional<openstudio::Time> defrost1StartTime() const; | ||
| 131 | |||
| 132 | boost::optional<openstudio::Time> defrost2StartTime() const; | ||
| 133 | |||
| 134 | boost::optional<openstudio::Time> defrost3StartTime() const; | ||
| 135 | |||
| 136 | boost::optional<openstudio::Time> defrost4StartTime() const; | ||
| 137 | |||
| 138 | boost::optional<openstudio::Time> defrost5StartTime() const; | ||
| 139 | |||
| 140 | boost::optional<openstudio::Time> defrost6StartTime() const; | ||
| 141 | |||
| 142 | boost::optional<openstudio::Time> defrost7StartTime() const; | ||
| 143 | |||
| 144 | boost::optional<openstudio::Time> defrost8StartTime() const; | ||
| 145 | |||
| 146 | std::vector<openstudio::Time> defrostStartTimes() const; | ||
| 147 | |||
| 148 | boost::optional<ThermalZone> zoneBoundaryThermalZone() const; | ||
| 149 | |||
| 150 | boost::optional<double> zoneBoundaryTotalInsulatedSurfaceAreaFacingZone() const; | ||
| 151 | |||
| 152 | boost::optional<double> zoneBoundaryAreaofGlassReachInDoorsFacingZone() const; | ||
| 153 | |||
| 154 | boost::optional<double> zoneBoundaryHeightofGlassReachInDoorsFacingZone() const; | ||
| 155 | |||
| 156 | boost::optional<double> zoneBoundaryAreaofStockingDoorsFacingZone() const; | ||
| 157 | |||
| 158 | boost::optional<double> zoneBoundaryHeightofStockingDoorsFacingZone() const; | ||
| 159 | |||
| 160 | boost::optional<double> zoneBoundaryInsulatedSurfaceUValueFacingZone() const; | ||
| 161 | |||
| 162 | boost::optional<double> zoneBoundaryGlassReachInDoorUValueFacingZone() const; | ||
| 163 | |||
| 164 | boost::optional<double> zoneBoundaryStockingDoorUValueFacingZone() const; | ||
| 165 | |||
| 166 | boost::optional<Schedule> zoneBoundaryStockingDoorOpeningScheduleFacingZone() const; | ||
| 167 | |||
| 168 | boost::optional<RefrigerationSystem> system() const; | ||
| 169 | |||
| 170 | boost::optional<RefrigerationSecondarySystem> secondarySystem() const; | ||
| 171 | |||
| 172 | boost::optional<RefrigerationCompressorRack> compressorRack() const; | ||
| 173 | |||
| 174 | //@} | ||
| 175 | /** @name Setters */ | ||
| 176 | //@{ | ||
| 177 | |||
| 178 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 179 | |||
| 180 | void resetAvailabilitySchedule(); | ||
| 181 | |||
| 182 | bool setRatedCoilCoolingCapacity(double ratedCoilCoolingCapacity); | ||
| 183 | |||
| 184 | bool setOperatingTemperature(double operatingTemperature); | ||
| 185 | |||
| 186 | bool setRatedCoolingSourceTemperature(double ratedCoolingSourceTemperature); | ||
| 187 | |||
| 188 | bool setRatedTotalHeatingPower(double ratedTotalHeatingPower); | ||
| 189 | |||
| 190 | bool setHeatingPowerSchedule(Schedule& schedule); | ||
| 191 | |||
| 192 | void resetHeatingPowerSchedule(); | ||
| 193 | |||
| 194 | bool setRatedCoolingCoilFanPower(double ratedCoolingCoilFanPower); | ||
| 195 | |||
| 196 | void resetRatedCoolingCoilFanPower(); | ||
| 197 | |||
| 198 | bool setRatedCirculationFanPower(double ratedCirculationFanPower); | ||
| 199 | |||
| 200 | void resetRatedCirculationFanPower(); | ||
| 201 | |||
| 202 | bool setRatedTotalLightingPower(double ratedTotalLightingPower); | ||
| 203 | |||
| 204 | bool setLightingSchedule(Schedule& schedule); | ||
| 205 | |||
| 206 | void resetLightingSchedule(); | ||
| 207 | |||
| 208 | bool setDefrostType(const std::string& defrostType); | ||
| 209 | |||
| 210 | void resetDefrostType(); | ||
| 211 | |||
| 212 | bool setDefrostControlType(const std::string& defrostControlType); | ||
| 213 | |||
| 214 | void resetDefrostControlType(); | ||
| 215 | |||
| 216 | bool setDefrostSchedule(Schedule& schedule); | ||
| 217 | |||
| 218 | bool setDefrostDripDownSchedule(Schedule& schedule); | ||
| 219 | |||
| 220 | void resetDefrostDripDownSchedule(); | ||
| 221 | |||
| 222 | bool setDefrostPower(boost::optional<double> defrostPower); | ||
| 223 | |||
| 224 | void resetDefrostPower(); | ||
| 225 | |||
| 226 | bool setTemperatureTerminationDefrostFractiontoIce(boost::optional<double> temperatureTerminationDefrostFractiontoIce); | ||
| 227 | |||
| 228 | void resetTemperatureTerminationDefrostFractiontoIce(); | ||
| 229 | |||
| 230 | bool setRestockingSchedule(Schedule& schedule); | ||
| 231 | |||
| 232 | void resetRestockingSchedule(); | ||
| 233 | |||
| 234 | bool setAverageRefrigerantChargeInventory(double averageRefrigerantChargeInventory); | ||
| 235 | |||
| 236 | void resetAverageRefrigerantChargeInventory(); | ||
| 237 | |||
| 238 | bool setInsulatedFloorSurfaceArea(double insulatedFloorSurfaceArea); | ||
| 239 | |||
| 240 | bool setInsulatedFloorUValue(double insulatedFloorUValue); | ||
| 241 | |||
| 242 | void resetInsulatedFloorUValue(); | ||
| 243 | |||
| 244 | bool setWalkinDefrostCycleParameters(const RefrigerationDefrostCycleParameters& walkinDefrostCycleParameters); | ||
| 245 | |||
| 246 | bool setDurationofDefrostCycle(boost::optional<int> durationofDefrostCycle); | ||
| 247 | |||
| 248 | void resetDurationofDefrostCycle(); | ||
| 249 | |||
| 250 | bool setDripDownTime(boost::optional<int> dripDownTime); | ||
| 251 | |||
| 252 | void resetDripDownTime(); | ||
| 253 | |||
| 254 | bool setDefrost1StartTime(const openstudio::Time& defrost1StartTime); | ||
| 255 | |||
| 256 | void resetDefrost1StartTime(); | ||
| 257 | |||
| 258 | bool setDefrost2StartTime(const openstudio::Time& defrost2StartTime); | ||
| 259 | |||
| 260 | void resetDefrost2StartTime(); | ||
| 261 | |||
| 262 | bool setDefrost3StartTime(const openstudio::Time& defrost3StartTime); | ||
| 263 | |||
| 264 | void resetDefrost3StartTime(); | ||
| 265 | |||
| 266 | bool setDefrost4StartTime(const openstudio::Time& defrost4StartTime); | ||
| 267 | |||
| 268 | void resetDefrost4StartTime(); | ||
| 269 | |||
| 270 | bool setDefrost5StartTime(const openstudio::Time& defrost5StartTime); | ||
| 271 | |||
| 272 | void resetDefrost5StartTime(); | ||
| 273 | |||
| 274 | bool setDefrost6StartTime(const openstudio::Time& defrost6StartTime); | ||
| 275 | |||
| 276 | void resetDefrost6StartTime(); | ||
| 277 | |||
| 278 | bool setDefrost7StartTime(const openstudio::Time& defrost7StartTime); | ||
| 279 | |||
| 280 | void resetDefrost7StartTime(); | ||
| 281 | |||
| 282 | bool setDefrost8StartTime(const openstudio::Time& defrost8StartTime); | ||
| 283 | |||
| 284 | void resetDefrost8StartTime(); | ||
| 285 | |||
| 286 | bool setZoneBoundaryThermalZone(const ThermalZone& zoneBoundaryThermalZone); | ||
| 287 | |||
| 288 | void resetZoneBoundaryThermalZone(); | ||
| 289 | |||
| 290 | bool setZoneBoundaryTotalInsulatedSurfaceAreaFacingZone(double zoneBoundaryTotalInsulatedSurfaceAreaFacingZone); | ||
| 291 | |||
| 292 | bool setZoneBoundaryAreaofGlassReachInDoorsFacingZone(double zoneBoundaryAreaofGlassReachInDoorsFacingZone); | ||
| 293 | |||
| 294 | bool setZoneBoundaryHeightofGlassReachInDoorsFacingZone(double zoneBoundaryHeightofGlassReachInDoorsFacingZone); | ||
| 295 | |||
| 296 | bool setZoneBoundaryAreaofStockingDoorsFacingZone(double zoneBoundaryAreaofStockingDoorsFacingZone); | ||
| 297 | |||
| 298 | bool setZoneBoundaryHeightofStockingDoorsFacingZone(double zoneBoundaryHeightofStockingDoorsFacingZone); | ||
| 299 | |||
| 300 | bool setZoneBoundaryInsulatedSurfaceUValueFacingZone(double zoneBoundaryInsulatedSurfaceUValueFacingZone); | ||
| 301 | |||
| 302 | bool setZoneBoundaryGlassReachInDoorUValueFacingZone(double zoneBoundaryGlassReachInDoorUValueFacingZone); | ||
| 303 | |||
| 304 | bool setZoneBoundaryStockingDoorUValueFacingZone(double zoneBoundaryStockingDoorUValueFacingZone); | ||
| 305 | |||
| 306 | bool setZoneBoundaryStockingDoorOpeningScheduleFacingZone(Schedule& zoneBoundaryStockingDoorOpeningScheduleFacingZone); | ||
| 307 | |||
| 308 | void resetZoneBoundaryStockingDoorOpeningScheduleFacingZone(); | ||
| 309 | |||
| 310 | bool addToSystem(RefrigerationSystem& system); | ||
| 311 | |||
| 312 | void removeFromSystem(); | ||
| 313 | |||
| 314 | bool addToSecondarySystem(RefrigerationSecondarySystem& secondarySystem); | ||
| 315 | |||
| 316 | void removeFromSecondarySystem(); | ||
| 317 | |||
| 318 | bool addToCompressorRack(RefrigerationCompressorRack& compressorRack); | ||
| 319 | |||
| 320 | void removeFromCompressorRack(); | ||
| 321 | |||
| 322 | //@} | ||
| 323 | /** @name Other */ | ||
| 324 | //@{ | ||
| 325 | |||
| 326 | //@} | ||
| 327 | protected: | ||
| 328 | private: | ||
| 329 | − | REGISTER_LOGGER("openstudio.model.RefrigerationWalkIn"); | |
| 330 | |||
| 331 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 332 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 333 | // objects should be returned as boost::optionals | ||
| 334 | boost::optional<Schedule> optionalDefrostSchedule() const; | ||
| 335 | |||
| 336 | RefrigerationWalkInZoneBoundary frontZoneBoundary(); | ||
| 337 | |||
| 338 | boost::optional<RefrigerationWalkInZoneBoundary> zoneBoundary() const; | ||
| 339 | }; | ||
| 340 | |||
| 341 | } // namespace detail | ||
| 342 | |||
| 343 | } // namespace model | ||
| 344 | } // namespace openstudio | ||
| 345 | |||
| 346 | #endif // MODEL_REFRIGERATIONWALKIN_IMPL_HPP | ||
| 347 |