GCC Code Coverage Report


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

src/model/ExteriorFuelEquipment.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_EXTERIORFUELEQUIPMENT_HPP
7 #define MODEL_EXTERIORFUELEQUIPMENT_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ExteriorLoadInstance.hpp"
11
12 namespace openstudio {
13
14 class FuelType;
15
16 namespace model {
17
18 class ExteriorFuelEquipmentDefinition;
19 class Facility;
20 class Schedule;
21
22 namespace detail {
23
24 class ExteriorFuelEquipment_Impl;
25
26 } // namespace detail
27
28 /** ExteriorFuelEquipment is a ExteriorLoadInstance that wraps the OpenStudio IDD object
29 * 'OS:Exterior:FuelEquipment'. ExteriorFuelEquipment is a child of Facility and instances
30 * ExteriorFuelEquipmentDefinition. */
31 class MODEL_API ExteriorFuelEquipment : public ExteriorLoadInstance
32 {
33 public:
34 /** @name Constructors and Destructors */
35 //@{
36
37 /** This constructor sets schedule to always on, defaults to Fuel Type = Electricity */
38 ExteriorFuelEquipment(const ExteriorFuelEquipmentDefinition& definition);
39
40 /** This constructor requires a user-specified schedule. */
41 ExteriorFuelEquipment(const ExteriorFuelEquipmentDefinition& definition, Schedule& schedule);
42
43 34 virtual ~ExteriorFuelEquipment() override = default;
44 // Default the copy and move operators because the virtual dtor is explicit
45 1 ExteriorFuelEquipment(const ExteriorFuelEquipment& other) = default;
46 11 ExteriorFuelEquipment(ExteriorFuelEquipment&& other) = default;
47 ✗ ExteriorFuelEquipment& operator=(const ExteriorFuelEquipment&) = default;
48 ✗ ExteriorFuelEquipment& operator=(ExteriorFuelEquipment&&) = default;
49
50 //@}
51
52 static IddObjectType iddObjectType();
53
54 static std::vector<std::string> fuelTypeValues();
55
56 /** \deprecated */
57 static std::vector<std::string> validFuelTypeValues();
58
59 /** @name Getters */
60 //@{
61
62 ExteriorFuelEquipmentDefinition exteriorFuelEquipmentDefinition() const;
63
64 Schedule schedule() const;
65
66 std::string fuelType() const;
67
68 double multiplier() const;
69
70 bool isMultiplierDefaulted() const;
71
72 std::string endUseSubcategory() const;
73
74 bool isEndUseSubcategoryDefaulted() const;
75
76 //@}
77 /** @name Setters */
78 //@{
79
80 bool setExteriorFuelEquipmentDefinition(const ExteriorFuelEquipmentDefinition& exteriorFuelEquipmentDefinition);
81
82 bool setSchedule(Schedule& schedule);
83
84 void resetSchedule();
85
86 bool setFuelType(const FuelType& fuelType);
87 bool setFuelType(const std::string& fuelType);
88
89 bool setMultiplier(double multiplier);
90
91 void resetMultiplier();
92
93 bool setEndUseSubcategory(const std::string& endUseSubcategory);
94
95 void resetEndUseSubcategory();
96
97 //@}
98 /** @name Other */
99 //@{
100
101 Facility facility() const;
102
103 //@}
104 protected:
105 /// @cond
106 using ImplType = detail::ExteriorFuelEquipment_Impl;
107
108 explicit ExteriorFuelEquipment(std::shared_ptr<detail::ExteriorFuelEquipment_Impl> impl);
109
110 friend class detail::ExteriorFuelEquipment_Impl;
111 friend class Model;
112 friend class IdfObject;
113 friend class openstudio::detail::IdfObject_Impl;
114 /// @endcond
115 private:
116 − REGISTER_LOGGER("openstudio.model.ExteriorFuelEquipment");
117 };
118
119 /** \relates ExteriorFuelEquipment*/
120 using OptionalExteriorFuelEquipment = boost::optional<ExteriorFuelEquipment>;
121
122 /** \relates ExteriorFuelEquipment*/
123 using ExteriorFuelEquipmentVector = std::vector<ExteriorFuelEquipment>;
124
125 } // namespace model
126 } // namespace openstudio
127
128 #endif // MODEL_EXTERIORFUELEQUIPMENT_HPP
129