GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 50.0% 40 / 0 / 80
Functions: 47.9% 34 / 0 / 71
Branches: 49.4% 132 / 0 / 267

src/utilities/data/DataEnums.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 UTILITIES_DATA_DATAENUMS_HPP
7 #define UTILITIES_DATA_DATAENUMS_HPP
8
9 #include "../UtilitiesAPI.hpp"
10 #include "../core/Enum.hpp"
11
12 namespace openstudio {
13
14 // clang-format off
15
16 /** \class InstallLocationType
17 * \brief EnergyPlus meter install location.
18 * \details See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual
19 * macro call is:
20 * \code
21 OPENSTUDIO_ENUM(InstallLocationType,
22 ((Facility))
23 ((Building))
24 ((HVAC))
25 ((Zone))
26 ((System))
27 ((Plant))
28 );
29 * \endcode */
30
11/22
openstudio::InstallLocationType::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 366 times.
✓ Branch 1 taken 1206 times.
✓ Branch 3 taken 366 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 366 times.
✗ Branch 9 not taken.
✗ Branch 12 not taken.
✓ Branch 17 taken 1206 times.
✓ Branch 20 taken 1206 times.
✓ Branch 23 taken 1310 times.
✓ Branch 24 taken 524 times.
✓ Branch 25 taken 262 times.
✓ Branch 26 taken 262 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 262 times.
openstudio::InstallLocationType::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::InstallLocationType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
12764 OPENSTUDIO_ENUM(InstallLocationType,
31 ((Facility))
32 ((Building))
33 ((HVAC))
34 ((Zone))
35 ((System))
36 ((Plant))
37 );
38
39 /** \class FuelType
40 * \brief EnergyPlus meterable fuel types.
41 * \details Use the valueDescription() for interfacing with EnergyPlus or setting an IDD field.
42 *
43 * See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual
44 * macro call is:
45 * \code
46 OPENSTUDIO_ENUM(FuelType,
47 ((Electricity))
48 ((Gas)(NaturalGas))
49 ((Gasoline))
50 ((Diesel))
51 ((Coal))
52 ((FuelOil_1)(FuelOilNo1))
53 ((FuelOil_2)(FuelOilNo2))
54 ((Propane))
55 ((Water))
56 ((Steam))
57 ((DistrictCooling))
58 ((DistrictHeating))
59 ((OtherFuel_1)(OtherFuel1))
60 ((OtherFuel_2)(OtherFuel2))
61 ((EnergyTransfer))
62 ((Solar))
63 ((Geothermal))
64 );
65 * \endcode */
66
15/22
openstudio::FuelType::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 4556 times.
✓ Branch 1 taken 4743 times.
✓ Branch 3 taken 4556 times.
✓ Branch 6 taken 1876 times.
✓ Branch 7 taken 2680 times.
✓ Branch 9 taken 1876 times.
✓ Branch 12 taken 1876 times.
✓ Branch 17 taken 4743 times.
✓ Branch 20 taken 4743 times.
✓ Branch 23 taken 8752 times.
✓ Branch 24 taken 1094 times.
✓ Branch 25 taken 547 times.
✓ Branch 26 taken 547 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 547 times.
openstudio::FuelType::enumName[abi:cxx11]():
✓ Branch 1 taken 3 times.
openstudio::operator<<(std::ostream&, openstudio::FuelType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
30203 OPENSTUDIO_ENUM(FuelType,
67 ((Electricity))
68 ((Gas)(NaturalGas))
69 ((Gasoline))
70 ((Diesel))
71 ((Coal))
72 ((FuelOil_1)(FuelOilNo1))
73 ((FuelOil_2)(FuelOilNo2))
74 ((Propane))
75 ((Water))
76 ((Steam)(DistrictHeatingSteam))
77 ((DistrictCooling))
78 ((DistrictHeating)(DistrictHeatingWater))
79 ((OtherFuel_1)(OtherFuel1))
80 ((OtherFuel_2)(OtherFuel2))
81 ((EnergyTransfer))
82 ((Solar))
83 ((Geothermal))
84 );
85
86 /** \relates FuelType */
87 using OptionalFuelType = boost::optional<FuelType>;
88
89 /** \relates FuelType */
90 using FuelTypeVector = std::vector<FuelType>;
91
92 /** \class EndUseFuelType
93 * \brief Fuel types reported by OpenStudio.
94 * \details See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual
95 * macro call is:
96 * \code
97 OPENSTUDIO_ENUM(EndUseFuelType,
98 ((Electricity)(Electricity))
99 ((Gas)(Natural Gas))
100 ((Gasoline))
101 ((Diesel))
102 ((Coal))
103 ((FuelOil_1)(Fuel Oil No 1))
104 ((FuelOil_2)(Fuel Oil No 2))
105 ((Propane))
106 ((OtherFuel_1)(Other Fuel 1))
107 ((OtherFuel_2)(Other Fuel 2))
108 ((DistrictCooling)(District Cooling))
109 ((DistrictHeating)(District Heating))
110 ((Water))
111 );
112 * \endcode */
113
14/22
openstudio::EndUseFuelType::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 154 times.
✓ Branch 1 taken 154 times.
✓ Branch 3 taken 154 times.
✓ Branch 6 taken 99 times.
✓ Branch 7 taken 55 times.
✓ Branch 9 taken 99 times.
✓ Branch 12 taken 99 times.
✓ Branch 17 taken 154 times.
✓ Branch 20 taken 154 times.
✓ Branch 23 taken 286 times.
✓ Branch 24 taken 44 times.
✓ Branch 25 taken 22 times.
✓ Branch 26 taken 22 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 22 times.
openstudio::EndUseFuelType::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::EndUseFuelType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
19233 OPENSTUDIO_ENUM(EndUseFuelType,
114 ((Electricity)(Electricity))
115 ((Gas)(Natural Gas))
116 ((Gasoline))
117 ((Diesel))
118 ((Coal))
119 ((FuelOil_1)(Fuel Oil No 1))
120 ((FuelOil_2)(Fuel Oil No 2))
121 ((Propane))
122 ((OtherFuel_1)(Other Fuel 1))
123 ((OtherFuel_2)(Other Fuel 2))
124 ((DistrictCooling)(District Cooling))
125 ((DistrictHeating)(District Heating Water))
126 ((DistrictHeatingSteam)(District Heating Steam))
127 ((Water))
128 );
129
130 /** \class EndUseCategoryType
131 * \brief End use categories reported by OpenStudio. These correspond to the "End Uses" table in the ABUPs report.
132 * \details See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual
133 * macro call is:
134 * \code
135 OPENSTUDIO_ENUM(EndUseCategoryType,
136 ((Heating)(Heating))
137 ((Cooling)(Cooling))
138 ((InteriorLights)(Interior Lighting))
139 ((ExteriorLights)(Exterior Lighting))
140 ((InteriorEquipment)(Interior Equipment))
141 ((ExteriorEquipment)(Exterior Equipment))
142 ((Fans)(Fans))
143 ((Pumps)(Pumps))
144 ((HeatRejection)(Heat Rejection))
145 ((Humidifier)(Humidification))
146 ((HeatRecovery)(Heat Recovery))
147 ((WaterSystems)(Water Systems))
148 ((Refrigeration)(Refrigeration))
149 ((Generators)(Generators))
150 );
151 * \endcode */
152
13/22
openstudio::EndUseCategoryType::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 140 times.
✓ Branch 1 taken 154 times.
✓ Branch 3 taken 140 times.
✓ Branch 6 taken 140 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 140 times.
✓ Branch 12 taken 140 times.
✓ Branch 17 taken 154 times.
✓ Branch 20 taken 154 times.
✓ Branch 23 taken 273 times.
✓ Branch 24 taken 42 times.
✓ Branch 25 taken 21 times.
✓ Branch 26 taken 21 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 21 times.
openstudio::EndUseCategoryType::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::EndUseCategoryType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
23264 OPENSTUDIO_ENUM(EndUseCategoryType,
153 ((Heating)(Heating))
154 ((Cooling)(Cooling))
155 ((InteriorLights)(Interior Lighting))
156 ((ExteriorLights)(Exterior Lighting))
157 ((InteriorEquipment)(Interior Equipment))
158 ((ExteriorEquipment)(Exterior Equipment))
159 ((Fans)(Fans))
160 ((Pumps)(Pumps))
161 ((HeatRejection)(Heat Rejection))
162 ((Humidifier)(Humidification))
163 ((HeatRecovery)(Heat Recovery))
164 ((WaterSystems)(Water Systems))
165 ((Refrigeration)(Refrigeration))
166 ((Generators)(Generators))
167 ); // DLM: this references the Cogeneration meter
168
169 /** \class EndUseType
170 * \brief End uses that can be metered by EnergyPlus. Some EndUseTypes correspond to EndUseCategoryTypes, others
171 * do not.
172 * \details See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual macro call is:
173 * \code
174 OPENSTUDIO_ENUM(EndUseType,
175 ((InteriorLights))
176 ((ExteriorLights))
177 ((InteriorEquipment))
178 ((ExteriorEquipment))
179 ((Fans))
180 ((Pumps))
181 ((Heating))
182 ((Cooling))
183 ((HeatRejection))
184 ((Humidifier))
185 ((HeatRecovery))
186 ((WaterSystems))
187 ((Cogeneration)(Generators))
188 ((Refrigeration))
189 ((HeatingCoils))
190 ((CoolingCoils))
191 ((Boilers))
192 ((Baseboard))
193 ((HeatRecoveryForCooling))
194 ((HeatRecoveryForHeating))
195 ((Chillers))
196 );
197 * \endcode */
198
15/22
openstudio::EndUseType::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 189 times.
✓ Branch 1 taken 189 times.
✓ Branch 3 taken 189 times.
✓ Branch 6 taken 9 times.
✓ Branch 7 taken 180 times.
✓ Branch 9 taken 9 times.
✓ Branch 12 taken 9 times.
✓ Branch 17 taken 189 times.
✓ Branch 20 taken 189 times.
✓ Branch 23 taken 360 times.
✓ Branch 24 taken 36 times.
✓ Branch 25 taken 18 times.
✓ Branch 26 taken 18 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 18 times.
openstudio::EndUseType::enumName[abi:cxx11]():
✓ Branch 1 taken 17 times.
openstudio::operator<<(std::ostream&, openstudio::EndUseType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
10603 OPENSTUDIO_ENUM(EndUseType,
199 ((InteriorLights))
200 ((ExteriorLights))
201 ((InteriorEquipment))
202 ((ExteriorEquipment))
203 ((Fans))
204 ((Pumps))
205 ((Heating))
206 ((Cooling))
207 ((HeatRejection))
208 ((Humidifier))
209 ((HeatRecovery))
210 ((WaterSystems))
211 ((Cogeneration)(Generators))
212 ((Refrigeration))
213 ((HeatingCoils))
214 ((CoolingCoils))
215 ((Boilers))
216 ((Baseboard))
217 ((HeatRecoveryForCooling))
218 ((HeatRecoveryForHeating))
219 ((Chillers))
220 );
221
222 /** \class BuildingSector
223 * \brief Commercial or residential.
224 * \details Used to differentiate between utility tariffs, building energy standards, etc.
225 * See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual macro call is:
226 * \code
227 OPENSTUDIO_ENUM(BuildingSector,
228 ((Commercial)(NonResidential))
229 ((Residential))
230 );
231 * \endcode */
232 ✗ OPENSTUDIO_ENUM(BuildingSector,
233 ((Commercial)(NonResidential))
234 ((Residential))
235 );
236
237
238
239
240 /** \class AppGFuelType
241 * \brief heat for coil for Appendix G system type selections
242 * \details See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual
243 * macro call is:
244 * \code
245 OPENSTUDIO_ENUM(AppGFuelType,
246 ((District))
247 ((Electric))
248 ((Fuel))
249 ((HeatPump))
250 ((Other))
251 ((Solar))
252 );
253 * \endcode */
254
8/22
openstudio::AppGFuelType::buildStringVec[abi:cxx11](bool):
✗ Branch 0 not taken.
✓ Branch 1 taken 84 times.
✗ Branch 3 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 9 not taken.
✗ Branch 12 not taken.
✓ Branch 17 taken 84 times.
✓ Branch 20 taken 84 times.
✓ Branch 23 taken 72 times.
✓ Branch 24 taken 24 times.
✓ Branch 25 taken 12 times.
✓ Branch 26 taken 12 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 12 times.
openstudio::AppGFuelType::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::AppGFuelType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
260 OPENSTUDIO_ENUM(AppGFuelType,
255 ((District))
256 ((Electric))
257 ((Fuel))
258 ((Geothermal))
259 ((HeatPump))
260 ((Other))
261 ((Solar))
262 );
263
264 /** \relates AppGFuelType */
265 using OptionalAppGFuelType = boost::optional<AppGFuelType>;
266
267 /** \relates AppGFuelType */
268 using AppGFuelTypeVector = std::vector<AppGFuelType>;
269
270 /** \class ComponentType
271 * \brief What an HVACComponent is meant to do: heating, cooling, both or none
272 * \details See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual
273 * macro call is:
274 * \code
275 OPENSTUDIO_ENUM(ComponentType,
276 ((Heating))
277 ((Cooling))
278 ((Both))
279 ((None))
280 );
281 * \endcode */
282
8/22
openstudio::ComponentType::buildStringVec[abi:cxx11](bool):
✗ Branch 0 not taken.
✓ Branch 1 taken 472 times.
✗ Branch 3 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 9 not taken.
✗ Branch 12 not taken.
✓ Branch 17 taken 472 times.
✓ Branch 20 taken 472 times.
✓ Branch 23 taken 354 times.
✓ Branch 24 taken 236 times.
✓ Branch 25 taken 118 times.
✓ Branch 26 taken 118 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 118 times.
openstudio::ComponentType::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::ComponentType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
5635 OPENSTUDIO_ENUM(ComponentType,
283 ((Heating))
284 ((Cooling))
285 ((Both))
286 ((None))
287 );
288
289 /** \relates ComponentType */
290 using OptionalComponentType = boost::optional<ComponentType>;
291
292 /** \relates ComponentType */
293 using ComponentTypeVector = std::vector<ComponentType>;
294
295
296
8/22
openstudio::AlfalfaComponentCapability::buildStringVec[abi:cxx11](bool):
✗ Branch 0 not taken.
✓ Branch 1 taken 27 times.
✗ Branch 3 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 9 not taken.
✗ Branch 12 not taken.
✓ Branch 17 taken 27 times.
✓ Branch 20 taken 27 times.
✓ Branch 23 taken 18 times.
✓ Branch 24 taken 18 times.
✓ Branch 25 taken 9 times.
✓ Branch 26 taken 9 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 9 times.
openstudio::AlfalfaComponentCapability::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::AlfalfaComponentCapability const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
433 OPENSTUDIO_ENUM(AlfalfaComponentCapability,
297 ((Input))
298 ((Output))
299 ((Bidirectional))
300 )
301 /** \relates AlfalfaComponentCapability */
302 using OptionalAlfalfaComponentCapability = boost::optional<AlfalfaComponentCapability>;
303
304 /** \relates AlfalfaComponentCapability */
305 using AlfalfaComponentCapabilityVector = std::vector<AlfalfaComponentCapability>;
306
307
308
8/22
openstudio::AlfalfaComponentType::buildStringVec[abi:cxx11](bool):
✗ Branch 0 not taken.
✓ Branch 1 taken 40 times.
✗ Branch 3 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✗ Branch 9 not taken.
✗ Branch 12 not taken.
✓ Branch 17 taken 40 times.
✓ Branch 20 taken 40 times.
✓ Branch 23 taken 32 times.
✓ Branch 24 taken 16 times.
✓ Branch 25 taken 8 times.
✓ Branch 26 taken 8 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 8 times.
openstudio::AlfalfaComponentType::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::AlfalfaComponentType const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
247 OPENSTUDIO_ENUM(AlfalfaComponentType,
309 ((Actuator))
310 ((Constant))
311 ((Meter))
312 ((OutputVariable))
313 ((GlobalVariable))
314 )
315 /** \relates AlfalfaComponentType */
316 using OptionalAlfalfaComponentType = boost::optional<AlfalfaComponentType>;
317
318 /** \relates AlfalfaComponentType */
319 using AlfalfaComponentTypeVector = std::vector<AlfalfaComponentType>;
320
321 // clang-format on
322
323 80 inline UTILITIES_API AppGFuelType convertFuelTypeToAppG(FuelType fuelType) {
324
325
3/3
✓ Branch 1 taken 80 times.
✓ Branch 4 taken 12 times.
✓ Branch 5 taken 68 times.
80 if (fuelType == FuelType::Electricity) {
326
1/1
✓ Branch 1 taken 12 times.
12 return AppGFuelType::Electric;
327
10/10
✓ Branch 1 taken 68 times.
✓ Branch 5 taken 53 times.
✓ Branch 8 taken 48 times.
✓ Branch 9 taken 5 times.
✓ Branch 11 taken 48 times.
✓ Branch 14 taken 40 times.
✓ Branch 15 taken 8 times.
✓ Branch 17 taken 40 times.
✓ Branch 20 taken 35 times.
✓ Branch 21 taken 5 times.
121 } else if ((fuelType == FuelType::Gas) || (fuelType == FuelType::Gasoline) || (fuelType == FuelType::Diesel) || (fuelType == FuelType::Coal)
328
9/9
✓ Branch 1 taken 35 times.
✓ Branch 4 taken 30 times.
✓ Branch 5 taken 5 times.
✓ Branch 7 taken 30 times.
✓ Branch 10 taken 25 times.
✓ Branch 11 taken 5 times.
✓ Branch 13 taken 25 times.
✓ Branch 16 taken 10 times.
✓ Branch 17 taken 15 times.
35 || (fuelType == FuelType::FuelOil_1) || (fuelType == FuelType::FuelOil_2) || (fuelType == FuelType::Propane)
329
8/10
✓ Branch 0 taken 53 times.
✓ Branch 1 taken 15 times.
✓ Branch 3 taken 10 times.
✓ Branch 6 taken 5 times.
✓ Branch 7 taken 5 times.
✓ Branch 9 taken 5 times.
✓ Branch 12 taken 5 times.
✗ Branch 13 not taken.
✓ Branch 14 taken 68 times.
✗ Branch 15 not taken.
121 || (fuelType == FuelType::OtherFuel_1) || (fuelType == FuelType::OtherFuel_2)) {
330
1/1
✓ Branch 1 taken 68 times.
68 return AppGFuelType::Fuel;
331 ✗ } else if ((fuelType == FuelType::DistrictCooling) || (fuelType == FuelType::DistrictHeating) || (fuelType == FuelType::Steam)) {
332 ✗ return AppGFuelType::District;
333 }
334
335 // (fuelType == FuelType::Water)
336 // (fuelType == FuelType::EnergyTransfer)
337
338 ✗ return AppGFuelType::Other;
339 }
340
341 } // namespace openstudio
342
343 #endif // UTILITIES_DATA_DATAENUMS_HPP
344