GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 40.0% 2 / 1 / 6
Functions: 40.0% 2 / 1 / 6
Branches: -% 0 / 1 / 1

src/model/ZoneHVACPackagedTerminalAirConditioner.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_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_HPP
7 #define MODEL_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ZoneHVACComponent.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class Schedule;
16 class HVACComponent;
17
18 namespace detail {
19
20 class ZoneHVACPackagedTerminalAirConditioner_Impl;
21
22 } // namespace detail
23
24 /** ZoneHVACPackagedTerminalAirConditioner is a ZoneHVACComponent that wraps the
25 * OpenStudio IDD object 'OS:ZoneHVAC:PackagedTerminalAirConditioner'. */
26 class MODEL_API ZoneHVACPackagedTerminalAirConditioner : public ZoneHVACComponent
27 {
28 public:
29 /** @name Constructors and Destructors */
30 //@{
31
32 ZoneHVACPackagedTerminalAirConditioner(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan,
33 HVACComponent& heatingCoil, HVACComponent& coolingCoil);
34
35 76 virtual ~ZoneHVACPackagedTerminalAirConditioner() override = default;
36 // Default the copy and move operators because the virtual dtor is explicit
37 ✗ ZoneHVACPackagedTerminalAirConditioner(const ZoneHVACPackagedTerminalAirConditioner& other) = default;
38 21 ZoneHVACPackagedTerminalAirConditioner(ZoneHVACPackagedTerminalAirConditioner&& other) = default;
39 ✗ ZoneHVACPackagedTerminalAirConditioner& operator=(const ZoneHVACPackagedTerminalAirConditioner&) = default;
40 ✗ ZoneHVACPackagedTerminalAirConditioner& operator=(ZoneHVACPackagedTerminalAirConditioner&&) = default;
41
42 //@}
43
44 static IddObjectType iddObjectType();
45
46 static std::vector<std::string> outdoorAirMixerObjectTypeValues();
47
48 /** \deprecated */
49 static std::vector<std::string> validOutdoorAirMixerObjectTypeValues();
50
51 static std::vector<std::string> fanPlacementValues();
52
53 /** \deprecated */
54 static std::vector<std::string> validFanPlacementValues();
55
56 /** @name Getters */
57 //@{
58
59 Schedule availabilitySchedule() const;
60
61 std::string outdoorAirMixerObjectType() const;
62
63 std::string outdoorAirMixerName() const;
64
65 /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate" **/
66 boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const;
67
68 bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const;
69
70 /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate" **/
71 boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const;
72
73 bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const;
74
75 /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate" **/
76 boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
77
78 bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const;
79
80 bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const;
81
82 /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate" **/
83 boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const;
84
85 bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const;
86
87 /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate" **/
88 boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const;
89
90 bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const;
91
92 /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate" **/
93 boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
94
95 bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const;
96
97 HVACComponent supplyAirFan() const;
98
99 HVACComponent heatingCoil() const;
100
101 HVACComponent coolingCoil() const;
102
103 std::string fanPlacement() const;
104
105 bool isFanPlacementDefaulted() const;
106
107 Schedule supplyAirFanOperatingModeSchedule() const;
108
109 //@}
110 /** @name Setters */
111 //@{
112
113 bool setAvailabilitySchedule(Schedule& schedule);
114
115 bool setOutdoorAirMixerObjectType(const std::string& outdoorAirMixerObjectType);
116
117 bool setOutdoorAirMixerName(const std::string& outdoorAirMixerName);
118
119 bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation);
120
121 void autosizeSupplyAirFlowRateDuringCoolingOperation();
122
123 bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation);
124
125 void autosizeSupplyAirFlowRateDuringHeatingOperation();
126
127 bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded);
128
129 void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
130
131 void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
132
133 bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed);
134
135 bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation);
136
137 void autosizeOutdoorAirFlowRateDuringCoolingOperation();
138
139 bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation);
140
141 void autosizeOutdoorAirFlowRateDuringHeatingOperation();
142
143 bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded);
144
145 void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
146
147 void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
148
149 bool setSupplyAirFan(HVACComponent& fan);
150
151 bool setHeatingCoil(HVACComponent& heatingCoil);
152
153 bool setCoolingCoil(HVACComponent& coolingCoil);
154
155 bool setFanPlacement(const std::string& fanPlacement);
156
157 void resetFanPlacement();
158
159 /** Sets the supply air fan operating mode schedule. Values of zero indicate that the fan
160 * cycles on and off with the active (heating or cooling) coil. Other values operate the
161 * fan continuously. */
162 bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule);
163
164 //@}
165 /** @name Other */
166 //@{
167
168 boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const;
169
170 boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const;
171
172 boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
173
174 boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const;
175
176 boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const;
177
178 boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
179
180 //@}
181 protected:
182 /// @cond
183 using ImplType = detail::ZoneHVACPackagedTerminalAirConditioner_Impl;
184
185 explicit ZoneHVACPackagedTerminalAirConditioner(std::shared_ptr<detail::ZoneHVACPackagedTerminalAirConditioner_Impl> impl);
186
187 friend class detail::ZoneHVACPackagedTerminalAirConditioner_Impl;
188 friend class Model;
189 friend class IdfObject;
190 friend class openstudio::detail::IdfObject_Impl;
191
192 /// @endcond
193 private:
194 − REGISTER_LOGGER("openstudio.model.ZoneHVACPackagedTerminalAirConditioner");
195 };
196
197 /** \relates ZoneHVACPackagedTerminalAirConditioner*/
198 using OptionalZoneHVACPackagedTerminalAirConditioner = boost::optional<ZoneHVACPackagedTerminalAirConditioner>;
199
200 /** \relates ZoneHVACPackagedTerminalAirConditioner*/
201 using ZoneHVACPackagedTerminalAirConditionerVector = std::vector<ZoneHVACPackagedTerminalAirConditioner>;
202
203 } // namespace model
204 } // namespace openstudio
205
206 #endif // MODEL_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_HPP
207