GCC Code Coverage Report


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

src/model/AirTerminalSingleDuctConstantVolumeFourPipeInduction.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_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEINDUCTION_HPP
7 #define MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEINDUCTION_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17 class Node;
18
19 namespace detail {
20
21 class AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl;
22
23 } // namespace detail
24
25 /** AirTerminalSingleDuctConstantVolumeFourPipeInduction is a StraightComponent that wraps the OpenStudio IDD object 'OS:AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction'. */
26 class MODEL_API AirTerminalSingleDuctConstantVolumeFourPipeInduction : public StraightComponent
27 {
28 public:
29 /** @name Constructors and Destructors */
30 //@{
31
32 explicit AirTerminalSingleDuctConstantVolumeFourPipeInduction(const Model& model, HVACComponent& heatingCoil);
33
34 54 virtual ~AirTerminalSingleDuctConstantVolumeFourPipeInduction() override = default;
35 // Default the copy and move operators because the virtual dtor is explicit
36 ✗ AirTerminalSingleDuctConstantVolumeFourPipeInduction(const AirTerminalSingleDuctConstantVolumeFourPipeInduction& other) = default;
37 16 AirTerminalSingleDuctConstantVolumeFourPipeInduction(AirTerminalSingleDuctConstantVolumeFourPipeInduction&& other) = default;
38 ✗ AirTerminalSingleDuctConstantVolumeFourPipeInduction& operator=(const AirTerminalSingleDuctConstantVolumeFourPipeInduction&) = default;
39 ✗ AirTerminalSingleDuctConstantVolumeFourPipeInduction& operator=(AirTerminalSingleDuctConstantVolumeFourPipeInduction&&) = default;
40
41 //@}
42
43 static IddObjectType iddObjectType();
44
45 /** @name Getters */
46 //@{
47
48 boost::optional<Schedule> availabilitySchedule() const;
49
50 boost::optional<double> maximumTotalAirFlowRate() const;
51
52 bool isMaximumTotalAirFlowRateAutosized() const;
53
54 double inductionRatio() const;
55
56 bool isInductionRatioDefaulted() const;
57
58 HVACComponent heatingCoil() const;
59
60 boost::optional<double> maximumHotWaterFlowRate() const;
61
62 bool isMaximumHotWaterFlowRateAutosized() const;
63
64 double minimumHotWaterFlowRate() const;
65
66 bool isMinimumHotWaterFlowRateDefaulted() const;
67
68 double heatingConvergenceTolerance() const;
69
70 bool isHeatingConvergenceToleranceDefaulted() const;
71
72 boost::optional<HVACComponent> coolingCoil() const;
73
74 boost::optional<double> maximumColdWaterFlowRate() const;
75
76 bool isMaximumColdWaterFlowRateAutosized() const;
77
78 double minimumColdWaterFlowRate() const;
79
80 bool isMinimumColdWaterFlowRateDefaulted() const;
81
82 double coolingConvergenceTolerance() const;
83
84 bool isCoolingConvergenceToleranceDefaulted() const;
85
86 boost::optional<Node> inducedAirInletNode() const;
87
88 unsigned inducedAirInletPort() const;
89
90 //@}
91 /** @name Setters */
92 //@{
93
94 bool setAvailabilitySchedule(Schedule& schedule);
95
96 void resetAvailabilitySchedule();
97
98 bool setMaximumTotalAirFlowRate(double maximumTotalAirFlowRate);
99
100 void autosizeMaximumTotalAirFlowRate();
101
102 bool setInductionRatio(double inductionRatio);
103
104 void resetInductionRatio();
105
106 bool setHeatingCoil(const HVACComponent& heatingCoil);
107
108 bool setMaximumHotWaterFlowRate(double maximumHotWaterFlowRate);
109
110 void resetMaximumHotWaterFlowRate();
111
112 void autosizeMaximumHotWaterFlowRate();
113
114 bool setMinimumHotWaterFlowRate(double minimumHotWaterFlowRate);
115
116 void resetMinimumHotWaterFlowRate();
117
118 bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance);
119
120 void resetHeatingConvergenceTolerance();
121
122 bool setCoolingCoil(const HVACComponent& coolingCoil);
123
124 void resetCoolingCoil();
125
126 bool setMaximumColdWaterFlowRate(double maximumColdWaterFlowRate);
127
128 void resetMaximumColdWaterFlowRate();
129
130 void autosizeMaximumColdWaterFlowRate();
131
132 bool setMinimumColdWaterFlowRate(double minimumColdWaterFlowRate);
133
134 void resetMinimumColdWaterFlowRate();
135
136 bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance);
137
138 void resetCoolingConvergenceTolerance();
139
140 //@}
141 /** @name Other */
142 //@{
143
144 boost::optional<double> autosizedMaximumTotalAirFlowRate() const;
145
146 boost::optional<double> autosizedMaximumHotWaterFlowRate() const;
147
148 boost::optional<double> autosizedMaximumColdWaterFlowRate() const;
149
150 //@}
151 protected:
152 /// @cond
153 using ImplType = detail::AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl;
154
155 explicit AirTerminalSingleDuctConstantVolumeFourPipeInduction(
156 std::shared_ptr<detail::AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl> impl);
157
158 friend class detail::AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl;
159 friend class Model;
160 friend class IdfObject;
161 friend class openstudio::detail::IdfObject_Impl;
162 /// @endcond
163 private:
164 REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctConstantVolumeFourPipeInduction");
165 };
166
167 /** \relates AirTerminalSingleDuctConstantVolumeFourPipeInduction*/
168 using OptionalAirTerminalSingleDuctConstantVolumeFourPipeInduction = boost::optional<AirTerminalSingleDuctConstantVolumeFourPipeInduction>;
169
170 /** \relates AirTerminalSingleDuctConstantVolumeFourPipeInduction*/
171 using AirTerminalSingleDuctConstantVolumeFourPipeInductionVector = std::vector<AirTerminalSingleDuctConstantVolumeFourPipeInduction>;
172
173 } // namespace model
174 } // namespace openstudio
175
176 #endif // MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEINDUCTION_HPP
177