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/SiteGroundTemperatureShallow.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_SITEGROUNDTEMPERATURESHALLOW_HPP
7 #define MODEL_SITEGROUNDTEMPERATURESHALLOW_HPP
8
9 #include <vector>
10 #include "ModelAPI.hpp"
11 #include "ModelObject.hpp"
12 #include "../utilities/time/Date.hpp"
13
14 namespace openstudio {
15 namespace model {
16
17 namespace detail {
18
19 class SiteGroundTemperatureShallow_Impl;
20
21 } // namespace detail
22
23 /** SiteGroundTemperatureShallow is a ModelObject that wraps the OpenStudio IDD object 'OS_Site_GroundTemperature_Shallow'. */
24 class MODEL_API SiteGroundTemperatureShallow : public ModelObject
25 {
26 public:
27 /** @name Constructors and Destructors */
28 //@{
29
30 17 virtual ~SiteGroundTemperatureShallow() override = default;
31 // Default the copy and move operators because the virtual dtor is explicit
32 ✗ SiteGroundTemperatureShallow(const SiteGroundTemperatureShallow& other) = default;
33 3 SiteGroundTemperatureShallow(SiteGroundTemperatureShallow&& other) = default;
34 ✗ SiteGroundTemperatureShallow& operator=(const SiteGroundTemperatureShallow&) = default;
35 ✗ SiteGroundTemperatureShallow& operator=(SiteGroundTemperatureShallow&&) = default;
36
37 //@}
38 /** @name Static Methods */
39 //@{
40
41 static IddObjectType iddObjectType();
42
43 //@}
44 /** @name Getters */
45 //@{
46
47 double januarySurfaceGroundTemperature() const;
48
49 bool isJanuarySurfaceGroundTemperatureDefaulted() const;
50
51 double februarySurfaceGroundTemperature() const;
52
53 bool isFebruarySurfaceGroundTemperatureDefaulted() const;
54
55 double marchSurfaceGroundTemperature() const;
56
57 bool isMarchSurfaceGroundTemperatureDefaulted() const;
58
59 double aprilSurfaceGroundTemperature() const;
60
61 bool isAprilSurfaceGroundTemperatureDefaulted() const;
62
63 double maySurfaceGroundTemperature() const;
64
65 bool isMaySurfaceGroundTemperatureDefaulted() const;
66
67 double juneSurfaceGroundTemperature() const;
68
69 bool isJuneSurfaceGroundTemperatureDefaulted() const;
70
71 double julySurfaceGroundTemperature() const;
72
73 bool isJulySurfaceGroundTemperatureDefaulted() const;
74
75 double augustSurfaceGroundTemperature() const;
76
77 bool isAugustSurfaceGroundTemperatureDefaulted() const;
78
79 double septemberSurfaceGroundTemperature() const;
80
81 bool isSeptemberSurfaceGroundTemperatureDefaulted() const;
82
83 double octoberSurfaceGroundTemperature() const;
84
85 bool isOctoberSurfaceGroundTemperatureDefaulted() const;
86
87 double novemberSurfaceGroundTemperature() const;
88
89 bool isNovemberSurfaceGroundTemperatureDefaulted() const;
90
91 double decemberSurfaceGroundTemperature() const;
92
93 bool isDecemberSurfaceGroundTemperatureDefaulted() const;
94
95 double getTemperatureByMonth(int month) const;
96
97 double getTemperatureByMonth(const openstudio::MonthOfYear& month) const;
98
99 bool isMonthDefaulted(int month) const;
100
101 bool isMonthDefaulted(const openstudio::MonthOfYear& month) const;
102
103 std::vector<double> getAllMonthlyTemperatures() const;
104
105 //@}
106 /** @name Setters */
107 //@{
108
109 bool setJanuarySurfaceGroundTemperature(double januarySurfaceGroundTemperature);
110
111 void resetJanuarySurfaceGroundTemperature();
112
113 bool setFebruarySurfaceGroundTemperature(double februarySurfaceGroundTemperature);
114
115 void resetFebruarySurfaceGroundTemperature();
116
117 bool setMarchSurfaceGroundTemperature(double marchSurfaceGroundTemperature);
118
119 void resetMarchSurfaceGroundTemperature();
120
121 bool setAprilSurfaceGroundTemperature(double aprilSurfaceGroundTemperature);
122
123 void resetAprilSurfaceGroundTemperature();
124
125 bool setMaySurfaceGroundTemperature(double maySurfaceGroundTemperature);
126
127 void resetMaySurfaceGroundTemperature();
128
129 bool setJuneSurfaceGroundTemperature(double juneSurfaceGroundTemperature);
130
131 void resetJuneSurfaceGroundTemperature();
132
133 bool setJulySurfaceGroundTemperature(double julySurfaceGroundTemperature);
134
135 void resetJulySurfaceGroundTemperature();
136
137 bool setAugustSurfaceGroundTemperature(double augustSurfaceGroundTemperature);
138
139 void resetAugustSurfaceGroundTemperature();
140
141 bool setSeptemberSurfaceGroundTemperature(double septemberSurfaceGroundTemperature);
142
143 void resetSeptemberSurfaceGroundTemperature();
144
145 bool setOctoberSurfaceGroundTemperature(double octoberSurfaceGroundTemperature);
146
147 void resetOctoberSurfaceGroundTemperature();
148
149 bool setNovemberSurfaceGroundTemperature(double novemberSurfaceGroundTemperature);
150
151 void resetNovemberSurfaceGroundTemperature();
152
153 bool setDecemberSurfaceGroundTemperature(double decemberSurfaceGroundTemperature);
154
155 void resetDecemberSurfaceGroundTemperature();
156
157 bool setTemperatureByMonth(int month, double temperature);
158
159 bool setTemperatureByMonth(const openstudio::MonthOfYear& month, double temperature);
160
161 void resetTemperatureByMonth(int month);
162
163 void resetTemperatureByMonth(const openstudio::MonthOfYear& month);
164
165 void resetAllMonths();
166
167 bool setAllMonthlyTemperatures(const std::vector<double>& monthly_temperatures);
168
169 //@}
170 protected:
171 /// @cond
172 using ImplType = detail::SiteGroundTemperatureShallow_Impl;
173
174 friend class Model;
175 friend class openstudio::IdfObject;
176 friend class detail::SiteGroundTemperatureShallow_Impl;
177
178 explicit SiteGroundTemperatureShallow(std::shared_ptr<detail::SiteGroundTemperatureShallow_Impl> impl);
179
180 explicit SiteGroundTemperatureShallow(Model& model);
181
182 /// @endcond
183 private:
184 REGISTER_LOGGER("openstudio.model.SiteGroundTemperatureShallow");
185 };
186
187 /** \relates SiteGroundTemperatureShallow*/
188 using OptionalSiteGroundTemperatureShallow = boost::optional<SiteGroundTemperatureShallow>;
189
190 /** \relates SiteGroundTemperatureShallow*/
191 using SiteGroundTemperatureShallowVector = std::vector<SiteGroundTemperatureShallow>;
192
193 } // namespace model
194 } // namespace openstudio
195
196 #endif // MODEL_SITEGROUNDTEMPERATURESHALLOW_HPP
197