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/SurfacePropertyOtherSideCoefficients.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_SURFACEPROPERTYOTHERSIDECOEFFICIENTS_HPP
7 #define MODEL_SURFACEPROPERTYOTHERSIDECOEFFICIENTS_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ResourceObject.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17
18 namespace detail {
19
20 class SurfacePropertyOtherSideCoefficients_Impl;
21
22 } // namespace detail
23
24 /** SurfacePropertyOtherSideCoefficients is a ResourceObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:OtherSideCoefficients'. */
25 class MODEL_API SurfacePropertyOtherSideCoefficients : public ResourceObject
26 {
27 public:
28 /** @name Constructors and Destructors */
29 //@{
30
31 explicit SurfacePropertyOtherSideCoefficients(const Model& model);
32
33 36 virtual ~SurfacePropertyOtherSideCoefficients() override = default;
34 // Default the copy and move operators because the virtual dtor is explicit
35 ✗ SurfacePropertyOtherSideCoefficients(const SurfacePropertyOtherSideCoefficients& other) = default;
36 20 SurfacePropertyOtherSideCoefficients(SurfacePropertyOtherSideCoefficients&& other) = default;
37 ✗ SurfacePropertyOtherSideCoefficients& operator=(const SurfacePropertyOtherSideCoefficients&) = default;
38 ✗ SurfacePropertyOtherSideCoefficients& operator=(SurfacePropertyOtherSideCoefficients&&) = default;
39
40 //@}
41
42 static IddObjectType iddObjectType();
43
44 /** @name Getters */
45 //@{
46
47 /** If set, this field becomes the exterior convective/radiative film coefficient
48 and the other fields are used to calculate the outdoor air temperature
49 then exterior surface temperature based on outdoor air and specified coefficient.
50 If not set, then remaining fields calculate the outside surface temperature. **/
51 boost::optional<double> combinedConvectiveRadiativeFilmCoefficient() const;
52
53 double constantTemperature() const;
54
55 bool isConstantTemperatureDefaulted() const;
56
57 double constantTemperatureCoefficient() const;
58
59 bool isConstantTemperatureCoefficientDefaulted() const;
60
61 double externalDryBulbTemperatureCoefficient() const;
62
63 bool isExternalDryBulbTemperatureCoefficientDefaulted() const;
64
65 double groundTemperatureCoefficient() const;
66
67 bool isGroundTemperatureCoefficientDefaulted() const;
68
69 double windSpeedCoefficient() const;
70
71 bool isWindSpeedCoefficientDefaulted() const;
72
73 double zoneAirTemperatureCoefficient() const;
74
75 bool isZoneAirTemperatureCoefficientDefaulted() const;
76
77 boost::optional<Schedule> constantTemperatureSchedule() const;
78
79 bool sinusoidalVariationofConstantTemperatureCoefficient() const;
80
81 bool isSinusoidalVariationofConstantTemperatureCoefficientDefaulted() const;
82
83 double periodofSinusoidalVariation() const;
84
85 bool isPeriodofSinusoidalVariationDefaulted() const;
86
87 double previousOtherSideTemperatureCoefficient() const;
88
89 bool isPreviousOtherSideTemperatureCoefficientDefaulted() const;
90
91 boost::optional<double> minimumOtherSideTemperatureLimit() const;
92
93 boost::optional<double> maximumOtherSideTemperatureLimit() const;
94
95 //@}
96 /** @name Setters */
97 //@{
98
99 bool setCombinedConvectiveRadiativeFilmCoefficient(double combinedConvectiveRadiativeFilmCoefficient);
100
101 void resetCombinedConvectiveRadiativeFilmCoefficient();
102
103 bool setConstantTemperature(double constantTemperature);
104
105 void resetConstantTemperature();
106
107 bool setConstantTemperatureCoefficient(double constantTemperatureCoefficient);
108
109 void resetConstantTemperatureCoefficient();
110
111 bool setExternalDryBulbTemperatureCoefficient(double externalDryBulbTemperatureCoefficient);
112
113 void resetExternalDryBulbTemperatureCoefficient();
114
115 bool setGroundTemperatureCoefficient(double groundTemperatureCoefficient);
116
117 void resetGroundTemperatureCoefficient();
118
119 bool setWindSpeedCoefficient(double windSpeedCoefficient);
120
121 void resetWindSpeedCoefficient();
122
123 bool setZoneAirTemperatureCoefficient(double zoneAirTemperatureCoefficient);
124
125 void resetZoneAirTemperatureCoefficient();
126
127 bool setConstantTemperatureSchedule(Schedule& schedule);
128
129 void resetConstantTemperatureSchedule();
130
131 bool setSinusoidalVariationofConstantTemperatureCoefficient(bool sinusoidalVariationofConstantTemperatureCoefficient);
132
133 void resetSinusoidalVariationofConstantTemperatureCoefficient();
134
135 bool setPeriodofSinusoidalVariation(double periodofSinusoidalVariation);
136
137 void resetPeriodofSinusoidalVariation();
138
139 bool setPreviousOtherSideTemperatureCoefficient(double previousOtherSideTemperatureCoefficient);
140
141 void resetPreviousOtherSideTemperatureCoefficient();
142
143 bool setMinimumOtherSideTemperatureLimit(double minimumOtherSideTemperatureLimit);
144
145 void resetMinimumOtherSideTemperatureLimit();
146
147 bool setMaximumOtherSideTemperatureLimit(double maximumOtherSideTemperatureLimit);
148
149 void resetMaximumOtherSideTemperatureLimit();
150
151 //@}
152 /** @name Other */
153 //@{
154
155 //@}
156 protected:
157 /// @cond
158 using ImplType = detail::SurfacePropertyOtherSideCoefficients_Impl;
159
160 explicit SurfacePropertyOtherSideCoefficients(std::shared_ptr<detail::SurfacePropertyOtherSideCoefficients_Impl> impl);
161
162 friend class detail::SurfacePropertyOtherSideCoefficients_Impl;
163 friend class Model;
164 friend class IdfObject;
165 friend class openstudio::detail::IdfObject_Impl;
166 /// @endcond
167 private:
168 REGISTER_LOGGER("openstudio.model.SurfacePropertyOtherSideCoefficients");
169 };
170
171 /** \relates SurfacePropertyOtherSideCoefficients*/
172 using OptionalSurfacePropertyOtherSideCoefficients = boost::optional<SurfacePropertyOtherSideCoefficients>;
173
174 /** \relates SurfacePropertyOtherSideCoefficients*/
175 using SurfacePropertyOtherSideCoefficientsVector = std::vector<SurfacePropertyOtherSideCoefficients>;
176
177 } // namespace model
178 } // namespace openstudio
179
180 #endif // MODEL_SURFACEPROPERTYOTHERSIDECOEFFICIENTS_HPP
181