GCC Code Coverage Report


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

src/model/AirLoopHVACReturnPlenum.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_AIRLOOPHVACRETURNPLENUM_HPP
7 #define MODEL_AIRLOOPHVACRETURNPLENUM_HPP
8
9 #include "ModelAPI.hpp"
10 #include "Mixer.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class ThermalZone;
16
17 namespace detail {
18
19 class AirLoopHVACReturnPlenum_Impl;
20
21 } // namespace detail
22
23 /** AirLoopHVACReturnPlenum is a Mixer that wraps the OpenStudio IDD object 'OS:AirLoopHVAC:ReturnPlenum'. */
24 class MODEL_API AirLoopHVACReturnPlenum : public Mixer
25 {
26 public:
27 explicit AirLoopHVACReturnPlenum(const Model& model);
28
29 264 virtual ~AirLoopHVACReturnPlenum() override = default;
30 // Default the copy and move operators because the virtual dtor is explicit
31 37 AirLoopHVACReturnPlenum(const AirLoopHVACReturnPlenum& other) = default;
32 106 AirLoopHVACReturnPlenum(AirLoopHVACReturnPlenum&& other) = default;
33 ✗ AirLoopHVACReturnPlenum& operator=(const AirLoopHVACReturnPlenum&) = default;
34 ✗ AirLoopHVACReturnPlenum& operator=(AirLoopHVACReturnPlenum&&) = default;
35
36 static IddObjectType iddObjectType();
37
38 boost::optional<ThermalZone> thermalZone() const;
39
40 /** Establish thermalZone as the plenum zone.
41 * If thermalZone is already conditioned by ThermalZone::equipment(),
42 * then this method will return false. A ThermalZone cannot be conditioned
43 * by equipment and and be a plenum zone. Remove any existing ZoneHVACComponent objects,
44 * and associated AirLoopHVAC objects before using this method on thermalZone.
45 **/
46 bool setThermalZone(const ThermalZone& thermalZone);
47
48 void resetThermalZone();
49
50 unsigned outletPort() const override;
51
52 unsigned inletPort(unsigned branchIndex) const override;
53
54 unsigned nextInletPort() const override;
55
56 bool addToNode(Node& node);
57
58 bool addBranchForZone(openstudio::model::ThermalZone& thermalZone);
59
60 bool addBranchForZone(openstudio::model::ThermalZone& thermalZone, HVACComponent& terminal);
61
62 protected:
63 /// @cond
64 using ImplType = detail::AirLoopHVACReturnPlenum_Impl;
65
66 explicit AirLoopHVACReturnPlenum(std::shared_ptr<detail::AirLoopHVACReturnPlenum_Impl> impl);
67
68 friend class detail::AirLoopHVACReturnPlenum_Impl;
69 friend class Model;
70 friend class IdfObject;
71 friend class openstudio::detail::IdfObject_Impl;
72 /// @endcond
73 private:
74 REGISTER_LOGGER("openstudio.model.AirLoopHVACReturnPlenum");
75 };
76
77 /** \relates AirLoopHVACReturnPlenum*/
78 using OptionalAirLoopHVACReturnPlenum = boost::optional<AirLoopHVACReturnPlenum>;
79
80 /** \relates AirLoopHVACReturnPlenum*/
81 using AirLoopHVACReturnPlenumVector = std::vector<AirLoopHVACReturnPlenum>;
82
83 } // namespace model
84 } // namespace openstudio
85
86 #endif // MODEL_AIRLOOPHVACRETURNPLENUM_HPP
87