GCC Code Coverage Report


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

src/model/UtilityBill_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_UTILITYBILL_IMPL_HPP
7 #define MODEL_UTILITYBILL_IMPL_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject_Impl.hpp"
11
12 namespace openstudio {
13
14 class FuelType;
15 class InstallLocationType;
16 class EndUseCategoryType;
17
18 namespace model {
19
20 class BillingPeriod;
21
22 namespace detail {
23
24 class MODEL_API UtilityBill_Impl : public ModelObject_Impl
25 {
26 public:
27 /** @name Constructors and Destructors */
28 //@{
29
30 UtilityBill_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
31
32 UtilityBill_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
33
34 UtilityBill_Impl(const UtilityBill_Impl& other, Model_Impl* model, bool keepHandle);
35
36 154 virtual ~UtilityBill_Impl() override = default;
37
38 //@}
39 /** @name Virtual Methods */
40 //@{
41
42 virtual const std::vector<std::string>& outputVariableNames() const override;
43
44 virtual IddObjectType iddObjectType() const override;
45
46 //@}
47 /** @name Getters */
48 //@{
49
50 std::vector<std::string> consumptionUnitValues() const;
51
52 std::vector<std::string> peakDemandUnitValues() const;
53
54 FuelType fuelType() const;
55
56 InstallLocationType meterInstallLocation() const;
57
58 bool isMeterInstallLocationDefaulted() const;
59
60 boost::optional<std::string> meterSpecificInstallLocation() const;
61
62 boost::optional<EndUseCategoryType> meterEndUseCategory() const;
63
64 boost::optional<std::string> meterSpecificEndUse() const;
65
66 std::string consumptionUnit() const;
67
68 boost::optional<std::string> consumptionUnitDescription() const;
69
70 double consumptionUnitConversionFactor() const;
71
72 bool isConsumptionUnitConversionFactorDefaulted() const;
73
74 boost::optional<std::string> peakDemandUnit() const;
75
76 boost::optional<std::string> peakDemandUnitDescription() const;
77
78 boost::optional<double> peakDemandUnitConversionFactor() const;
79
80 boost::optional<unsigned> timestepsInPeakDemandWindow() const;
81
82 bool isTimestepsInPeakDemandWindowDefaulted() const;
83
84 boost::optional<double> minutesInPeakDemandWindow() const;
85
86 std::vector<BillingPeriod> billingPeriods() const;
87
88 //@}
89 /** @name Setters */
90 //@{
91
92 bool setMeterInstallLocation(const InstallLocationType& meterInstallLocation);
93
94 void resetMeterInstallLocation();
95
96 bool setMeterSpecificInstallLocation(const std::string& meterSpecificInstallLocation);
97
98 void resetMeterSpecificInstallLocation();
99
100 bool setMeterEndUseCategory(const EndUseCategoryType& meterEndUseCategory);
101
102 void resetMeterEndUseCategory();
103
104 bool setMeterSpecificEndUse(const std::string& meterSpecificEndUse);
105
106 void resetMeterSpecificEndUse();
107
108 bool setConsumptionUnit(const std::string& consumptionUnit);
109
110 bool setConsumptionUnitConversionFactor(double consumptionUnitConversionFactor);
111
112 void resetConsumptionUnitConversionFactor();
113
114 bool setPeakDemandUnit(const std::string& peakDemandUnit);
115
116 bool setTimestepsInPeakDemandWindow(unsigned timestepsInPeakDemandWindow);
117
118 void resetTimestepsInPeakDemandWindow();
119
120 void clearBillingPeriods();
121
122 BillingPeriod addBillingPeriod();
123
124 //@}
125 /** @name Other */
126 //@{
127
128 OutputMeter consumptionMeter() const;
129
130 boost::optional<OutputMeter> peakDemandMeter() const;
131
132 unsigned numberBillingPeriodsInCalculations() const;
133
134 boost::optional<double> CVRMSE() const;
135
136 boost::optional<double> NMBE() const;
137
138 //@}
139 protected:
140 private:
141 − REGISTER_LOGGER("openstudio.model.UtilityBill");
142 };
143
144 } // namespace detail
145
146 } // namespace model
147 } // namespace openstudio
148
149 #endif // MODEL_UTILITYBILL_IMPL_HPP
150