GCC Code Coverage Report


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

src/model/SwimmingPoolIndoor.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_SWIMMINGPOOLINDOOR_HPP
7 #define MODEL_SWIMMINGPOOLINDOOR_HPP
8
9 #include <model/ModelAPI.hpp>
10 #include "StraightComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Surface;
17 class Schedule;
18 class Node;
19
20 namespace detail {
21
22 class SwimmingPoolIndoor_Impl;
23
24 } // namespace detail
25
26 /** SwimmingPoolIndoor is a StraightComponent that wraps the OpenStudio IDD object 'OS:SwimmingPool:Indoor'. */
27 class MODEL_API SwimmingPoolIndoor : public StraightComponent
28 {
29 public:
30 /** @name Constructors and Destructors */
31 //@{
32
33 explicit SwimmingPoolIndoor(const Model& model, const Surface& floorSurface);
34
35 5 virtual ~SwimmingPoolIndoor() override = default;
36 // Default the copy and move operators because the virtual dtor is explicit
37 ✗ SwimmingPoolIndoor(const SwimmingPoolIndoor& other) = default;
38 ✗ SwimmingPoolIndoor(SwimmingPoolIndoor&& other) = default;
39 ✗ SwimmingPoolIndoor& operator=(const SwimmingPoolIndoor&) = default;
40 ✗ SwimmingPoolIndoor& operator=(SwimmingPoolIndoor&&) = default;
41
42 //@}
43
44 static IddObjectType iddObjectType();
45
46 /** @name Getters */
47 //@{
48
49 Surface surface() const;
50
51 double averageDepth() const;
52
53 Schedule activityFactorSchedule() const;
54
55 Schedule makeupWaterSupplySchedule() const;
56
57 Schedule coverSchedule() const;
58
59 double coverEvaporationFactor() const;
60
61 double coverConvectionFactor() const;
62
63 double coverShortWavelengthRadiationFactor() const;
64
65 double coverLongWavelengthRadiationFactor() const;
66
67 double poolHeatingSystemMaximumWaterFlowRate() const;
68
69 double poolMiscellaneousEquipmentPower() const;
70
71 Schedule setpointTemperatureSchedule() const;
72
73 double maximumNumberofPeople() const;
74
75 Schedule peopleSchedule() const;
76
77 Schedule peopleHeatGainSchedule() const;
78
79 //@}
80 /** @name Setters */
81 //@{
82
83 // Set the Pool's surface object. Surface MUST be of type 'Floor'
84 bool setSurface(const Surface& floorSurface);
85
86 bool setAverageDepth(double averageDepth);
87
88 bool setActivityFactorSchedule(Schedule& schedule);
89
90 bool setMakeupWaterSupplySchedule(Schedule& schedule);
91
92 bool setCoverSchedule(Schedule& schedule);
93
94 bool setCoverEvaporationFactor(double coverEvaporationFactor);
95
96 bool setCoverConvectionFactor(double coverConvectionFactor);
97
98 bool setCoverShortWavelengthRadiationFactor(double coverShortWavelengthRadiationFactor);
99
100 bool setCoverLongWavelengthRadiationFactor(double coverLongWavelengthRadiationFactor);
101
102 bool setPoolHeatingSystemMaximumWaterFlowRate(double poolHeatingSystemMaximumWaterFlowRate);
103
104 bool setPoolMiscellaneousEquipmentPower(double poolMiscellaneousEquipmentPower);
105
106 bool setSetpointTemperatureSchedule(Schedule& schedule);
107
108 bool setMaximumNumberofPeople(double maximumNumberofPeople);
109
110 bool setPeopleSchedule(Schedule& schedule);
111
112 bool setPeopleHeatGainSchedule(Schedule& schedule);
113
114 //@}
115 /** @name Other */
116 //@{
117
118 // Convenience function to return the inletNode of the Pool object
119 boost::optional<Node> poolWaterInletNode() const;
120
121 // Convenience function to return the Outlet Node of the Pool object
122 boost::optional<Node> poolWaterOutletNode() const;
123
124 //@}
125 protected:
126 /// @cond
127 using ImplType = detail::SwimmingPoolIndoor_Impl;
128
129 explicit SwimmingPoolIndoor(std::shared_ptr<detail::SwimmingPoolIndoor_Impl> impl);
130
131 friend class detail::SwimmingPoolIndoor_Impl;
132 friend class Model;
133 friend class IdfObject;
134 friend class openstudio::detail::IdfObject_Impl;
135 /// @endcond
136 private:
137 − REGISTER_LOGGER("openstudio.model.SwimmingPoolIndoor");
138 };
139
140 /** \relates SwimmingPoolIndoor*/
141 using OptionalSwimmingPoolIndoor = boost::optional<SwimmingPoolIndoor>;
142
143 /** \relates SwimmingPoolIndoor*/
144 using SwimmingPoolIndoorVector = std::vector<SwimmingPoolIndoor>;
145
146 } // namespace model
147 } // namespace openstudio
148
149 #endif // MODEL_SWIMMINGPOOLINDOOR_HPP
150