GCC Code Coverage Report


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

src/model/AirTerminalSingleDuctConstantVolumeFourPipeBeam.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_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEBEAM_HPP
7 #define MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEBEAM_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class HVACComponent;
17 class Schedule;
18 class Node;
19 class HVACComponent;
20 class PlantLoop;
21
22 namespace detail {
23
24 class AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl;
25
26 } // namespace detail
27
28 /** AirTerminalSingleDuctConstantVolumeFourPipeBeam is a StraightComponent that wraps the OpenStudio IDD object 'OS:AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam'. */
29 class MODEL_API AirTerminalSingleDuctConstantVolumeFourPipeBeam : public StraightComponent
30 {
31 public:
32 /** @name Constructors and Destructors */
33 //@{
34
35 AirTerminalSingleDuctConstantVolumeFourPipeBeam(const Model& model, HVACComponent& coilCoolingFourPipeBeam,
36 HVACComponent& coilHeatingFourPipeBeam);
37
38 /* This constructor does not instantiate any CoilCoolingFourPipeBeam nor CoilHeatingFourPipeBeam. At least one of these two is required
39 * for this object to be ForwardTranslated, so you will have to do it manually and use setCoolingCoil and/or setHeatingCoil */
40 AirTerminalSingleDuctConstantVolumeFourPipeBeam(const Model& model);
41
42 43 virtual ~AirTerminalSingleDuctConstantVolumeFourPipeBeam() override = default;
43 // Default the copy and move operators because the virtual dtor is explicit
44 ✗ AirTerminalSingleDuctConstantVolumeFourPipeBeam(const AirTerminalSingleDuctConstantVolumeFourPipeBeam& other) = default;
45 13 AirTerminalSingleDuctConstantVolumeFourPipeBeam(AirTerminalSingleDuctConstantVolumeFourPipeBeam&& other) = default;
46 ✗ AirTerminalSingleDuctConstantVolumeFourPipeBeam& operator=(const AirTerminalSingleDuctConstantVolumeFourPipeBeam&) = default;
47 ✗ AirTerminalSingleDuctConstantVolumeFourPipeBeam& operator=(AirTerminalSingleDuctConstantVolumeFourPipeBeam&&) = default;
48
49 //@}
50
51 static IddObjectType iddObjectType();
52
53 /** @name Getters */
54 //@{
55
56 /** Availability Schedules */
57
58 Schedule primaryAirAvailabilitySchedule() const;
59
60 Schedule coolingAvailabilitySchedule() const;
61
62 Schedule heatingAvailabilitySchedule() const;
63
64 boost::optional<Node> primaryAirInletNode() const;
65 boost::optional<Node> primaryAirOutletNode() const;
66
67 /* This returns an optional because you can omit the cooling coil if you are modeling a heating-only beam
68 * The only child class it will return is a CoilCoolingFourPipeBeam */
69 boost::optional<HVACComponent> coolingCoil() const;
70
71 /* This returns an optional because you can omit the heating coil if you are modeling a cooling-only beam
72 * The only child class it will return is a CoilHeatingFourPipeBeam */
73 boost::optional<HVACComponent> heatingCoil() const;
74
75 /** Autosizable fields */
76
77 boost::optional<double> designPrimaryAirVolumeFlowRate() const;
78 bool isDesignPrimaryAirVolumeFlowRateAutosized() const;
79
80 boost::optional<double> designChilledWaterVolumeFlowRate() const;
81 bool isDesignChilledWaterVolumeFlowRateAutosized() const;
82
83 boost::optional<double> designHotWaterVolumeFlowRate() const;
84 bool isDesignHotWaterVolumeFlowRateAutosized() const;
85
86 boost::optional<double> zoneTotalBeamLength() const;
87 bool isZoneTotalBeamLengthAutosized() const;
88
89 /* Double fields with defaults */
90 double ratedPrimaryAirFlowRateperBeamLength() const;
91 bool isRatedPrimaryAirFlowRateperBeamLengthDefaulted() const;
92
93 //@}
94 /** @name Setters */
95 //@{
96
97 bool setPrimaryAirAvailabilitySchedule(Schedule& schedule);
98
99 bool setCoolingAvailabilitySchedule(Schedule& schedule);
100
101 bool setHeatingAvailabilitySchedule(Schedule& schedule);
102
103 /* Set Cooling and Heating Coil. */
104
105 /* The only object this method will accept is the companion class CoilCoolingFourPipeBeam */
106 bool setCoolingCoil(const HVACComponent& coilCoolingFourPipeBeam);
107
108 /* The only object this method will accept is the companion class CoilHeatingFourPipeBeam */
109 bool setHeatingCoil(const HVACComponent& coilHeatingFourPipeBeam);
110
111 /* Autosizable fields */
112 bool setDesignPrimaryAirVolumeFlowRate(double designPrimaryAirVolumeFlowRate);
113 void autosizeDesignPrimaryAirVolumeFlowRate();
114
115 bool setDesignChilledWaterVolumeFlowRate(double designChilledWaterVolumeFlowRate);
116 void autosizeDesignChilledWaterVolumeFlowRate();
117
118 bool setDesignHotWaterVolumeFlowRate(double designHotWaterVolumeFlowRate);
119 void autosizeDesignHotWaterVolumeFlowRate();
120
121 bool setZoneTotalBeamLength(double zoneTotalBeamLength);
122 void autosizeZoneTotalBeamLength();
123
124 bool setRatedPrimaryAirFlowRateperBeamLength(double ratedPrimaryAirFlowRateperBeamLength);
125
126 void resetRatedPrimaryAirFlowRateperBeamLength();
127
128 //@}
129 /** @name Other */
130 //@{
131
132 /* Convenience method to return the chilled water PlantLoop */
133 boost::optional<PlantLoop> chilledWaterPlantLoop() const;
134 boost::optional<Node> chilledWaterInletNode() const;
135 boost::optional<Node> chilledWaterOutletNode() const;
136
137 /* Convenience method to return the hot water PlantLoop */
138 boost::optional<PlantLoop> hotWaterPlantLoop() const;
139 boost::optional<Node> hotWaterInletNode() const;
140 boost::optional<Node> hotWaterOutletNode() const;
141
142 /* Queries the SQL file after a successful sizing run */
143 boost::optional<double> autosizedDesignPrimaryAirVolumeFlowRate();
144 boost::optional<double> autosizedDesignChilledWaterVolumeFlowRate();
145 boost::optional<double> autosizedDesignHotWaterVolumeFlowRate();
146 boost::optional<double> autosizedZoneTotalBeamLength();
147
148 //@}
149 protected:
150 /// @cond
151 using ImplType = detail::AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl;
152
153 explicit AirTerminalSingleDuctConstantVolumeFourPipeBeam(std::shared_ptr<detail::AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl> impl);
154
155 friend class detail::AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl;
156 friend class Model;
157 friend class IdfObject;
158 friend class openstudio::detail::IdfObject_Impl;
159 /// @endcond
160 private:
161 − REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctConstantVolumeFourPipeBeam");
162 };
163
164 /** \relates AirTerminalSingleDuctConstantVolumeFourPipeBeam*/
165 using OptionalAirTerminalSingleDuctConstantVolumeFourPipeBeam = boost::optional<AirTerminalSingleDuctConstantVolumeFourPipeBeam>;
166
167 /** \relates AirTerminalSingleDuctConstantVolumeFourPipeBeam*/
168 using AirTerminalSingleDuctConstantVolumeFourPipeBeamVector = std::vector<AirTerminalSingleDuctConstantVolumeFourPipeBeam>;
169
170 } // namespace model
171 } // namespace openstudio
172
173 #endif // MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEBEAM_HPP
174