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/BoilerHotWater.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_BOILERHOTWATER_HPP
7 #define MODEL_BOILERHOTWATER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent.hpp"
11 #include "../utilities/core/Deprecated.hpp"
12
13 namespace openstudio {
14
15 namespace model {
16
17 class Curve;
18
19 namespace detail {
20
21 class BoilerHotWater_Impl;
22
23 } // namespace detail
24
25 /** BoilerHotWater is a StraightComponent that wraps the OpenStudio IDD object
26 * 'OS:Boiler:HotWater'. */
27 class MODEL_API BoilerHotWater : public StraightComponent
28 {
29 public:
30 /** @name Constructors and Destructors */
31 //@{
32
33 explicit BoilerHotWater(const Model& model);
34
35 94 virtual ~BoilerHotWater() override = default;
36 // Default the copy and move operators because the virtual dtor is explicit
37 1 BoilerHotWater(const BoilerHotWater& other) = default;
38 4 BoilerHotWater(BoilerHotWater&& other) = default;
39 ✗ BoilerHotWater& operator=(const BoilerHotWater&) = default;
40 ✗ BoilerHotWater& operator=(BoilerHotWater&&) = default;
41
42 //@}
43
44 static IddObjectType iddObjectType();
45
46 static std::vector<std::string> validFuelTypeValues();
47
48 static std::vector<std::string> validEfficiencyCurveTemperatureEvaluationVariableValues();
49
50 static std::vector<std::string> validBoilerFlowModeValues();
51
52 /** @name Getters */
53 //@{
54
55 std::string fuelType() const;
56
57 boost::optional<double> nominalCapacity() const;
58
59 bool isNominalCapacityAutosized() const;
60
61 double nominalThermalEfficiency() const;
62
63 boost::optional<std::string> efficiencyCurveTemperatureEvaluationVariable() const;
64
65 boost::optional<Curve> normalizedBoilerEfficiencyCurve() const;
66
67 boost::optional<double> designWaterFlowRate() const;
68
69 bool isDesignWaterFlowRateAutosized() const;
70
71 double minimumPartLoadRatio() const;
72
73 bool isMinimumPartLoadRatioDefaulted() const;
74
75 double maximumPartLoadRatio() const;
76
77 bool isMaximumPartLoadRatioDefaulted() const;
78
79 double optimumPartLoadRatio() const;
80
81 bool isOptimumPartLoadRatioDefaulted() const;
82
83 double waterOutletUpperTemperatureLimit() const;
84
85 bool isWaterOutletUpperTemperatureLimitDefaulted() const;
86
87 std::string boilerFlowMode() const;
88
89 bool isBoilerFlowModeDefaulted() const;
90
91 OS_DEPRECATED(3, 7, 0) boost::optional<double> parasiticElectricLoad() const;
92
93 double onCycleParasiticElectricLoad() const;
94
95 double sizingFactor() const;
96
97 bool isSizingFactorDefaulted() const;
98
99 std::string endUseSubcategory() const;
100
101 double offCycleParasiticFuelLoad() const;
102
103 //@}
104 /** @name Setters */
105 //@{
106
107 bool setFuelType(const std::string& fuelType);
108
109 bool setNominalCapacity(double nominalCapacity);
110
111 void resetNominalCapacity();
112
113 void autosizeNominalCapacity();
114
115 bool setNominalThermalEfficiency(double nominalThermalEfficiency);
116
117 bool setEfficiencyCurveTemperatureEvaluationVariable(const std::string& efficiencyCurveTemperatureEvaluationVariable);
118
119 void resetEfficiencyCurveTemperatureEvaluationVariable();
120
121 bool setNormalizedBoilerEfficiencyCurve(const Curve& normalizedBoilerEfficiencyCurve);
122
123 void resetNormalizedBoilerEfficiencyCurve();
124
125 bool setDesignWaterFlowRate(double designWaterFlowRate);
126
127 void resetDesignWaterFlowRate();
128
129 void autosizeDesignWaterFlowRate();
130
131 bool setMinimumPartLoadRatio(double minimumPartLoadRatio);
132
133 void resetMinimumPartLoadRatio();
134
135 bool setMaximumPartLoadRatio(double maximumPartLoadRatio);
136
137 void resetMaximumPartLoadRatio();
138
139 bool setOptimumPartLoadRatio(double optimumPartLoadRatio);
140
141 void resetOptimumPartLoadRatio();
142
143 bool setWaterOutletUpperTemperatureLimit(double waterOutletUpperTemperatureLimit);
144
145 void resetWaterOutletUpperTemperatureLimit();
146
147 bool setBoilerFlowMode(const std::string& boilerFlowMode);
148
149 void resetBoilerFlowMode();
150
151 OS_DEPRECATED(3, 7, 0) bool setParasiticElectricLoad(double parasiticElectricLoad);
152
153 bool setOnCycleParasiticElectricLoad(double onCyclearasiticElectricLoad);
154
155 OS_DEPRECATED(3, 7, 0) void resetParasiticElectricLoad();
156
157 bool setSizingFactor(double sizingFactor);
158
159 void resetSizingFactor();
160
161 boost::optional<double> autosizedNominalCapacity() const;
162
163 boost::optional<double> autosizedDesignWaterFlowRate() const;
164
165 bool setEndUseSubcategory(const std::string& endUseSubcategory);
166
167 bool setOffCycleParasiticFuelLoad(double offCycleParasiticFuelLoad);
168
169 //@}
170 protected:
171 /// @cond
172 using ImplType = detail::BoilerHotWater_Impl;
173
174 friend class detail::BoilerHotWater_Impl;
175 friend class Model;
176 friend class openstudio::detail::IdfObject_Impl;
177 friend class IdfObject;
178
179 explicit BoilerHotWater(std::shared_ptr<detail::BoilerHotWater_Impl> impl);
180
181 /// @endcond
182 private:
183 − REGISTER_LOGGER("openstudio.model.BoilerHotWater");
184 };
185
186 /** \relates BoilerHotWater*/
187 using OptionalBoilerHotWater = boost::optional<BoilerHotWater>;
188
189 /** \relates BoilerHotWater*/
190 using BoilerHotWaterVector = std::vector<BoilerHotWater>;
191
192 } // namespace model
193 } // namespace openstudio
194
195 #endif // MODEL_BOILERHOTWATER_HPP
196