GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 80.0% 4 / 0 / 5
Functions: 80.0% 4 / 0 / 5
Branches: -% 0 / 0 / 0

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