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/CoilHeatingFourPipeBeam.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_COILHEATINGFOURPIPEBEAM_HPP
7 #define MODEL_COILHEATINGFOURPIPEBEAM_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Node;
17 class Curve;
18 class AirTerminalSingleDuctConstantVolumeFourPipeBeam;
19
20 namespace detail {
21
22 class CoilHeatingFourPipeBeam_Impl;
23
24 } // namespace detail
25
26 /** CoilHeatingFourPipeBeam is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Heating:FourPipeBeam'. */
27 class MODEL_API CoilHeatingFourPipeBeam : public StraightComponent
28 {
29 public:
30 /** @name Constructors and Destructors */
31 //@{
32
33 explicit CoilHeatingFourPipeBeam(const Model& model);
34
35 54 virtual ~CoilHeatingFourPipeBeam() override = default;
36 // Default the copy and move operators because the virtual dtor is explicit
37 1 CoilHeatingFourPipeBeam(const CoilHeatingFourPipeBeam& other) = default;
38 22 CoilHeatingFourPipeBeam(CoilHeatingFourPipeBeam&& other) = default;
39 ✗ CoilHeatingFourPipeBeam& operator=(const CoilHeatingFourPipeBeam&) = default;
40 ✗ CoilHeatingFourPipeBeam& operator=(CoilHeatingFourPipeBeam&&) = default;
41
42 //@}
43
44 static IddObjectType iddObjectType();
45
46 /** @name Getters */
47 //@{
48
49 boost::optional<Node> hotWaterInletNode() const;
50
51 boost::optional<Node> hotWaterOutletNode() const;
52
53 double beamRatedHeatingCapacityperBeamLength() const;
54 bool isBeamRatedHeatingCapacityperBeamLengthDefaulted() const;
55
56 double beamRatedHeatingRoomAirHotWaterTemperatureDifference() const;
57 bool isBeamRatedHeatingRoomAirHotWaterTemperatureDifferenceDefaulted() const;
58
59 double beamRatedHotWaterVolumeFlowRateperBeamLength() const;
60 bool isBeamRatedHotWaterVolumeFlowRateperBeamLengthDefaulted() const;
61
62 Curve beamHeatingCapacityTemperatureDifferenceModificationFactorCurve() const;
63
64 Curve beamHeatingCapacityAirFlowModificationFactorCurve() const;
65
66 Curve beamHeatingCapacityHotWaterFlowModificationFactorCurve() const;
67
68 //@}
69 /** @name Setters */
70 //@{
71
72 bool setBeamRatedHeatingCapacityperBeamLength(double beamRatedHeatingCapacityperBeamLength);
73 void resetBeamRatedHeatingCapacityperBeamLength();
74
75 bool setBeamRatedHeatingRoomAirHotWaterTemperatureDifference(double beamRatedHeatingRoomAirHotWaterTemperatureDifference);
76 void resetBeamRatedHeatingRoomAirHotWaterTemperatureDifference();
77
78 bool setBeamRatedHotWaterVolumeFlowRateperBeamLength(double beamRatedHotWaterVolumeFlowRateperBeamLength);
79 void resetBeamRatedHotWaterVolumeFlowRateperBeamLength();
80
81 bool setBeamHeatingCapacityTemperatureDifferenceModificationFactorCurve(const Curve& curve);
82
83 bool setBeamHeatingCapacityAirFlowModificationFactorCurve(const Curve& curve);
84
85 bool setBeamHeatingCapacityHotWaterFlowModificationFactorCurve(const Curve& curve);
86
87 // No reset functions provided for the three curves, because all curves are required if you connect the ATU FourPipeBeam to a hot water plant loop
88 // And given that we added a subclass specifically for the heating portion of the ATU FourPipeBeam, they become required at all times
89
90 //@}
91 /** @name Other */
92 //@{
93
94 /* Convenience function to return the parent AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam */
95 boost::optional<AirTerminalSingleDuctConstantVolumeFourPipeBeam> airTerminalSingleDuctConstantVolumeFourPipeBeam() const;
96
97 //@}
98 protected:
99 /// @cond
100 using ImplType = detail::CoilHeatingFourPipeBeam_Impl;
101
102 explicit CoilHeatingFourPipeBeam(std::shared_ptr<detail::CoilHeatingFourPipeBeam_Impl> impl);
103
104 friend class detail::CoilHeatingFourPipeBeam_Impl;
105 friend class Model;
106 friend class IdfObject;
107 friend class openstudio::detail::IdfObject_Impl;
108 /// @endcond
109 private:
110 REGISTER_LOGGER("openstudio.model.CoilHeatingFourPipeBeam");
111 };
112
113 /** \relates CoilHeatingFourPipeBeam*/
114 using OptionalCoilHeatingFourPipeBeam = boost::optional<CoilHeatingFourPipeBeam>;
115
116 /** \relates CoilHeatingFourPipeBeam*/
117 using CoilHeatingFourPipeBeamVector = std::vector<CoilHeatingFourPipeBeam>;
118
119 } // namespace model
120 } // namespace openstudio
121
122 #endif // MODEL_COILHEATINGFOURPIPEBEAM_HPP
123