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/RadianceParameters.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_RADIANCEPARAMETERS_HPP
7 #define MODEL_RADIANCEPARAMETERS_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 namespace detail {
17
18 class RadianceParameters_Impl;
19
20 } // namespace detail
21
22 /** RadianceParameters is a ModelObject that wraps the OpenStudio IDD object 'OS:RadianceParameters'. */
23 class MODEL_API RadianceParameters : public ModelObject
24 {
25 public:
26 /** @name Constructors and Destructors */
27 //@{
28
29 42 virtual ~RadianceParameters() override = default;
30 // Default the copy and move operators because the virtual dtor is explicit
31 21 RadianceParameters(const RadianceParameters& other) = default;
32 6 RadianceParameters(RadianceParameters&& other) = default;
33 ✗ RadianceParameters& operator=(const RadianceParameters&) = default;
34 ✗ RadianceParameters& operator=(RadianceParameters&&) = default;
35
36 //@}
37
38 static IddObjectType iddObjectType();
39
40 static std::vector<std::string> skyDiscretizationResolutionValues();
41
42 /** @name Getters */
43 //@{
44
45 int accumulatedRaysperRecord() const;
46
47 bool isAccumulatedRaysperRecordDefaulted() const;
48
49 double directThreshold() const;
50
51 bool isDirectThresholdDefaulted() const;
52
53 double directCertainty() const;
54
55 bool isDirectCertaintyDefaulted() const;
56
57 double directJitter() const;
58
59 bool isDirectJitterDefaulted() const;
60
61 double directPretest() const;
62
63 bool isDirectPretestDefaulted() const;
64
65 int ambientBouncesVMX() const;
66
67 bool isAmbientBouncesVMXDefaulted() const;
68
69 int ambientBouncesDMX() const;
70
71 bool isAmbientBouncesDMXDefaulted() const;
72
73 int ambientDivisionsVMX() const;
74
75 bool isAmbientDivisionsVMXDefaulted() const;
76
77 int ambientDivisionsDMX() const;
78
79 bool isAmbientDivisionsDMXDefaulted() const;
80
81 int ambientSupersamples() const;
82
83 bool isAmbientSupersamplesDefaulted() const;
84
85 double limitWeightVMX() const;
86
87 bool isLimitWeightVMXDefaulted() const;
88
89 double limitWeightDMX() const;
90
91 bool isLimitWeightDMXDefaulted() const;
92
93 int klemsSamplingDensity() const;
94
95 bool isKlemsSamplingDensityDefaulted() const;
96
97 // Note JM 2018-12-12: It's a discrete choice field of numbers, perhaps we should return as an int?
98 std::string skyDiscretizationResolution() const;
99
100 bool isCoarseSettings();
101
102 bool isFineSettings();
103
104 //@}
105 /** @name Setters */
106 //@{
107
108 bool setAccumulatedRaysperRecord(int accumulatedRaysperRecord);
109
110 void resetAccumulatedRaysperRecord();
111
112 bool setDirectThreshold(double directThreshold);
113
114 void resetDirectThreshold();
115
116 bool setDirectCertainty(double directCertainty);
117
118 void resetDirectCertainty();
119
120 bool setDirectJitter(double directJitter);
121
122 void resetDirectJitter();
123
124 bool setDirectPretest(double directPretest);
125
126 void resetDirectPretest();
127
128 bool setAmbientBouncesVMX(int ambientBouncesVMX);
129
130 void resetAmbientBouncesVMX();
131
132 bool setAmbientBouncesDMX(int ambientBouncesDMX);
133
134 void resetAmbientBouncesDMX();
135
136 bool setAmbientDivisionsVMX(int ambientDivisionsVMX);
137
138 void resetAmbientDivisionsVMX();
139
140 bool setAmbientDivisionsDMX(int ambientDivisionsDMX);
141
142 void resetAmbientDivisionsDMX();
143
144 bool setAmbientSupersamples(int ambientSupersamples);
145
146 void resetAmbientSupersamples();
147
148 bool setLimitWeightVMX(double limitWeightVMX);
149
150 void resetLimitWeightVMX();
151
152 bool setLimitWeightDMX(double limitWeightDMX);
153
154 void resetLimitWeightDMX();
155
156 bool setKlemsSamplingDensity(int klemsSamplingDensity);
157
158 void resetKlemsSamplingDensity();
159
160 bool setSkyDiscretizationResolution(const std::string& skyDiscretizationResolution);
161
162 void resetSkyDiscretizationResolution();
163
164 void applyCoarseSettings();
165
166 void applyFineSettings();
167
168 //@}
169 /** @name Other */
170 //@{
171
172 //@}
173 protected:
174 /// @cond
175 using ImplType = detail::RadianceParameters_Impl;
176
177 explicit RadianceParameters(std::shared_ptr<detail::RadianceParameters_Impl> impl);
178
179 friend class detail::RadianceParameters_Impl;
180 friend class Model;
181 friend class IdfObject;
182 friend class openstudio::detail::IdfObject_Impl;
183 explicit RadianceParameters(Model& model);
184
185 /// @endcond
186 private:
187 REGISTER_LOGGER("openstudio.model.RadianceParameters");
188 };
189
190 /** \relates RadianceParameters*/
191 using OptionalRadianceParameters = boost::optional<RadianceParameters>;
192
193 /** \relates RadianceParameters*/
194 using RadianceParametersVector = std::vector<RadianceParameters>;
195
196 } // namespace model
197 } // namespace openstudio
198
199 #endif // MODEL_RADIANCEPARAMETERS_HPP
200