A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
test-parabolic-antenna.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011,12 CTTC
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Nicola Baldo <nbaldo@cttc.es>
7 */
8
9#include "ns3/double.h"
10#include "ns3/log.h"
11#include "ns3/parabolic-antenna-model.h"
12#include "ns3/simulator.h"
13#include "ns3/test.h"
14
15#include <cmath>
16#include <iostream>
17#include <sstream>
18#include <string>
19
20using namespace ns3;
21
22NS_LOG_COMPONENT_DEFINE("TestParabolicAntennaModel");
23
24/**
25 * @ingroup antenna-tests
26 *
27 * @brief Test condition (equal to or less than)
28 */
34
35/**
36 * @ingroup antenna-tests
37 *
38 * @brief ParabolicAntennaModel Test
39 */
40class ParabolicAntennaModelTestCase : public TestCase
41{
42 public:
43 /**
44 * Build the test name
45 * @param a Antenna angle
46 * @param b Beamwidth
47 * @param o Orientation
48 * @param g MaxGain
49 * @return the test name
50 */
51 static std::string BuildNameString(Angles a, double b, double o, double g);
52 /**
53 * Constructor
54 * @param a Antenna angle
55 * @param b Beamwidth
56 * @param o Orientation
57 * @param g MaxGain
58 * @param expectedGainDb Expected antenna gain
59 * @param cond Test condition
60 */
61 ParabolicAntennaModelTestCase(Angles a,
62 double b,
63 double o,
64 double g,
65 double expectedGainDb,
66 ParabolicAntennaModelGainTestCondition cond);
67
68 private:
69 void DoRun() override;
70
71 Angles m_a; //!< Antenna angle
72 double m_b; //!< Beamwidth
73 double m_o; //!< Orientation
74 double m_g; //!< MaxGain
75 double m_expectedGain; //!< Expected gain
76 ParabolicAntennaModelGainTestCondition m_cond; //!< Test condition
77};
78
79std::string
80ParabolicAntennaModelTestCase::BuildNameString(Angles a, double b, double o, double g)
81{
82 std::ostringstream oss;
83 oss << "theta=" << a.GetInclination() << " , phi=" << a.GetAzimuth() << ", beamdwidth=" << b
84 << "deg, orientation=" << o << ", maxAttenuation=" << g << " dB";
85 return oss.str();
86}
87
88ParabolicAntennaModelTestCase::ParabolicAntennaModelTestCase(
89 Angles a,
90 double b,
91 double o,
92 double g,
93 double expectedGainDb,
94 ParabolicAntennaModelGainTestCondition cond)
95 : TestCase(BuildNameString(a, b, o, g)),
96 m_a(a),
97 m_b(b),
98 m_o(o),
99 m_g(g),
100 m_expectedGain(expectedGainDb),
101 m_cond(cond)
102{
103}
104
105void
106ParabolicAntennaModelTestCase::DoRun()
107{
108 NS_LOG_FUNCTION(this << BuildNameString(m_a, m_b, m_o, m_g));
109
110 Ptr<ParabolicAntennaModel> a = CreateObject<ParabolicAntennaModel>();
111 a->SetAttribute("Beamwidth", DoubleValue(m_b));
112 a->SetAttribute("Orientation", DoubleValue(m_o));
113 a->SetAttribute("MaxAttenuation", DoubleValue(m_g));
114 double actualGain = a->GetGainDb(m_a);
115 switch (m_cond)
116 {
117 case EQUAL:
118 NS_TEST_EXPECT_MSG_EQ_TOL(actualGain,
119 m_expectedGain,
120 0.001,
121 "wrong value of the radiation pattern");
122 break;
123 case LESSTHAN:
124 NS_TEST_EXPECT_MSG_LT(actualGain, m_expectedGain, "gain higher than expected");
125 break;
126 default:
127 break;
128 }
129}
130
131/**
132 * @ingroup antenna-tests
133 *
134 * @brief ParabolicAntennaModel TestSuite
135 */
141
142ParabolicAntennaModelTestSuite::ParabolicAntennaModelTestSuite()
143 : TestSuite("parabolic-antenna-model", Type::UNIT)
144{
145 // with a 60 deg beamwidth, gain is -20dB at +-77.460 degrees from boresight
146 // phi, theta,
147 // beamwidth,
148 // orientation, maxAttn,
149 // expectedGain,
150 // condition
151 AddTestCase(new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(0), DegreesToRadians(90)),
152 60,
153 0,
154 20,
155 0,
156 EQUAL),
157 TestCase::Duration::QUICK);
158 AddTestCase(
159 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(30), DegreesToRadians(90)),
160 60,
161 0,
162 20,
163 -3,
164 EQUAL),
165 TestCase::Duration::QUICK);
166 AddTestCase(
167 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-30), DegreesToRadians(90)),
168 60,
169 0,
170 20,
171 -3,
172 EQUAL),
173 TestCase::Duration::QUICK);
174 AddTestCase(
175 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-90), DegreesToRadians(90)),
176 60,
177 0,
178 20,
179 -20,
180 EQUAL),
181 TestCase::Duration::QUICK);
182 AddTestCase(
183 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(90), DegreesToRadians(90)),
184 60,
185 0,
186 20,
187 -20,
188 EQUAL),
189 TestCase::Duration::QUICK);
190 AddTestCase(
191 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(100), DegreesToRadians(90)),
192 60,
193 0,
194 20,
195 -20,
196 EQUAL),
197 TestCase::Duration::QUICK);
198 AddTestCase(
199 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(150), DegreesToRadians(90)),
200 60,
201 0,
202 20,
203 -20,
204 EQUAL),
205 TestCase::Duration::QUICK);
206 AddTestCase(
207 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(180), DegreesToRadians(90)),
208 60,
209 0,
210 20,
211 -20,
212 EQUAL),
213 TestCase::Duration::QUICK);
214 AddTestCase(
215 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-100), DegreesToRadians(90)),
216 60,
217 0,
218 20,
219 -20,
220 EQUAL),
221 TestCase::Duration::QUICK);
222 AddTestCase(
223 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-150), DegreesToRadians(90)),
224 60,
225 0,
226 20,
227 -20,
228 EQUAL),
229 TestCase::Duration::QUICK);
230 AddTestCase(
231 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-180), DegreesToRadians(90)),
232 60,
233 0,
234 20,
235 -20,
236 EQUAL),
237 TestCase::Duration::QUICK);
238
239 // with a 60 deg beamwidth, gain is -10dB at +-54.772 degrees from boresight
240 // test positive orientation
241 AddTestCase(
242 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(60), DegreesToRadians(90)),
243 60,
244 60,
245 10,
246 0,
247 EQUAL),
248 TestCase::Duration::QUICK);
249 AddTestCase(
250 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(90), DegreesToRadians(90)),
251 60,
252 60,
253 10,
254 -3,
255 EQUAL),
256 TestCase::Duration::QUICK);
257 AddTestCase(
258 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(30), DegreesToRadians(90)),
259 60,
260 60,
261 10,
262 -3,
263 EQUAL),
264 TestCase::Duration::QUICK);
265 AddTestCase(
266 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-30), DegreesToRadians(90)),
267 60,
268 60,
269 10,
270 -10,
271 EQUAL),
272 TestCase::Duration::QUICK);
273 AddTestCase(
274 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(150), DegreesToRadians(90)),
275 60,
276 60,
277 10,
278 -10,
279 EQUAL),
280 TestCase::Duration::QUICK);
281 AddTestCase(
282 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(160), DegreesToRadians(90)),
283 60,
284 60,
285 10,
286 -10,
287 EQUAL),
288 TestCase::Duration::QUICK);
289 AddTestCase(
290 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(210), DegreesToRadians(90)),
291 60,
292 60,
293 10,
294 -10,
295 EQUAL),
296 TestCase::Duration::QUICK);
297 AddTestCase(
298 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(240), DegreesToRadians(90)),
299 60,
300 60,
301 10,
302 -10,
303 EQUAL),
304 TestCase::Duration::QUICK);
305 AddTestCase(
306 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-40), DegreesToRadians(90)),
307 60,
308 60,
309 10,
310 -10,
311 EQUAL),
312 TestCase::Duration::QUICK);
313 AddTestCase(
314 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-90), DegreesToRadians(90)),
315 60,
316 60,
317 10,
318 -10,
319 EQUAL),
320 TestCase::Duration::QUICK);
321 AddTestCase(
322 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-120), DegreesToRadians(90)),
323 60,
324 60,
325 10,
326 -10,
327 EQUAL),
328 TestCase::Duration::QUICK);
329
330 // test negative orientation and different beamwidths
331 // with a 80 deg beamwidth, gain is -20dB at +- 73.030 degrees from boresight
332 AddTestCase(
333 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-150), DegreesToRadians(90)),
334 80,
335 -150,
336 10,
337 0,
338 EQUAL),
339 TestCase::Duration::QUICK);
340 AddTestCase(
341 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-110), DegreesToRadians(90)),
342 80,
343 -150,
344 10,
345 -3,
346 EQUAL),
347 TestCase::Duration::QUICK);
348 AddTestCase(
349 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-190), DegreesToRadians(90)),
350 80,
351 -150,
352 10,
353 -3,
354 EQUAL),
355 TestCase::Duration::QUICK);
356 AddTestCase(
357 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-70), DegreesToRadians(90)),
358 80,
359 -150,
360 10,
361 -10,
362 EQUAL),
363 TestCase::Duration::QUICK);
364 AddTestCase(
365 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(92), DegreesToRadians(90)),
366 80,
367 -150,
368 10,
369 -10,
370 EQUAL),
371 TestCase::Duration::QUICK);
372 AddTestCase(
373 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-30), DegreesToRadians(90)),
374 80,
375 -150,
376 10,
377 -10,
378 EQUAL),
379 TestCase::Duration::QUICK);
380 AddTestCase(new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(0), DegreesToRadians(90)),
381 80,
382 -150,
383 10,
384 -10,
385 EQUAL),
386 TestCase::Duration::QUICK);
387 AddTestCase(
388 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(60), DegreesToRadians(90)),
389 80,
390 -150,
391 10,
392 -10,
393 EQUAL),
394 TestCase::Duration::QUICK);
395 AddTestCase(
396 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(90), DegreesToRadians(90)),
397 80,
398 -150,
399 10,
400 -10,
401 EQUAL),
402 TestCase::Duration::QUICK);
403 AddTestCase(
404 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(30), DegreesToRadians(90)),
405 80,
406 -150,
407 10,
408 -10,
409 EQUAL),
410 TestCase::Duration::QUICK);
411
412 // test elevation angle
413 AddTestCase(new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(0), DegreesToRadians(88)),
414 60,
415 0,
416 20,
417 0,
418 EQUAL),
419 TestCase::Duration::QUICK);
420 AddTestCase(
421 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(30), DegreesToRadians(88)),
422 60,
423 0,
424 20,
425 -3,
426 EQUAL),
427 TestCase::Duration::QUICK);
428 AddTestCase(
429 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-30), DegreesToRadians(88)),
430 60,
431 0,
432 20,
433 -3,
434 EQUAL),
435 TestCase::Duration::QUICK);
436 AddTestCase(
437 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-90), DegreesToRadians(88)),
438 60,
439 0,
440 20,
441 -20,
442 EQUAL),
443 TestCase::Duration::QUICK);
444 AddTestCase(
445 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-180), DegreesToRadians(88)),
446 60,
447 0,
448 20,
449 -20,
450 EQUAL),
451 TestCase::Duration::QUICK);
452 AddTestCase(
453 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(60), DegreesToRadians(93)),
454 60,
455 60,
456 20,
457 0,
458 EQUAL),
459 TestCase::Duration::QUICK);
460 AddTestCase(
461 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(90), DegreesToRadians(93)),
462 60,
463 60,
464 20,
465 -3,
466 EQUAL),
467 TestCase::Duration::QUICK);
468 AddTestCase(
469 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(30), DegreesToRadians(93)),
470 60,
471 60,
472 20,
473 -3,
474 EQUAL),
475 TestCase::Duration::QUICK);
476 AddTestCase(
477 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-120), DegreesToRadians(93)),
478 60,
479 60,
480 20,
481 -20,
482 EQUAL),
483 TestCase::Duration::QUICK);
484 AddTestCase(
485 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-150), DegreesToRadians(93)),
486 100,
487 -150,
488 10,
489 0,
490 EQUAL),
491 TestCase::Duration::QUICK);
492 AddTestCase(
493 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-100), DegreesToRadians(93)),
494 100,
495 -150,
496 10,
497 -3,
498 EQUAL),
499 TestCase::Duration::QUICK);
500 AddTestCase(
501 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-200), DegreesToRadians(93)),
502 100,
503 -150,
504 10,
505 -3,
506 EQUAL),
507 TestCase::Duration::QUICK);
508 AddTestCase(
509 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-30), DegreesToRadians(93)),
510 100,
511 -150,
512 10,
513 -10,
514 EQUAL),
515 TestCase::Duration::QUICK);
516 AddTestCase(
517 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(90), DegreesToRadians(80.5)),
518 100,
519 -150,
520 10,
521 -10,
522 EQUAL),
523 TestCase::Duration::QUICK);
524 AddTestCase(
525 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(0), DegreesToRadians(80.5)),
526 60,
527 0,
528 20,
529 0,
530 EQUAL),
531 TestCase::Duration::QUICK);
532 AddTestCase(
533 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(30), DegreesToRadians(80.5)),
534 60,
535 0,
536 20,
537 -3,
538 EQUAL),
539 TestCase::Duration::QUICK);
540 AddTestCase(
541 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-30), DegreesToRadians(80.5)),
542 60,
543 0,
544 20,
545 -3,
546 EQUAL),
547 TestCase::Duration::QUICK);
548 AddTestCase(
549 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(100), DegreesToRadians(80.5)),
550 60,
551 0,
552 20,
553 -20,
554 EQUAL),
555 TestCase::Duration::QUICK);
556 AddTestCase(
557 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-150), DegreesToRadians(80.5)),
558 100,
559 -150,
560 30,
561 0,
562 EQUAL),
563 TestCase::Duration::QUICK);
564 AddTestCase(
565 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-100), DegreesToRadians(80.5)),
566 100,
567 -150,
568 30,
569 -3,
570 EQUAL),
571 TestCase::Duration::QUICK);
572 AddTestCase(
573 new ParabolicAntennaModelTestCase(Angles(DegreesToRadians(-200), DegreesToRadians(80.5)),
574 100,
575 -150,
576 30,
577 -3,
578 EQUAL),
579 TestCase::Duration::QUICK);
580}
581
582/// Static variable for test initialization
583static ParabolicAntennaModelTestSuite g_staticParabolicAntennaModelTestSuiteInstance;
ParabolicAntennaModelTestCase
ParabolicAntennaModel Test.
Definition test-parabolic-antenna.cc:41
ParabolicAntennaModelTestCase::BuildNameString
static std::string BuildNameString(Angles a, double b, double o, double g)
Build the test name.
Definition test-parabolic-antenna.cc:80
ParabolicAntennaModelTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition test-parabolic-antenna.cc:106
ParabolicAntennaModelTestCase::m_cond
ParabolicAntennaModelGainTestCondition m_cond
Test condition.
Definition test-parabolic-antenna.cc:76
ParabolicAntennaModelTestCase::ParabolicAntennaModelTestCase
ParabolicAntennaModelTestCase(Angles a, double b, double o, double g, double expectedGainDb, ParabolicAntennaModelGainTestCondition cond)
Constructor.
Definition test-parabolic-antenna.cc:88
ParabolicAntennaModelTestSuite
ParabolicAntennaModel TestSuite.
Definition test-parabolic-antenna.cc:137
ns3::Angles
Class holding the azimuth and inclination angles of spherical coordinates.
Definition angles.h:107
ns3::Angles::GetInclination
double GetInclination() const
Getter for inclination angle.
Definition angles.cc:236
ns3::Angles::GetAzimuth
double GetAzimuth() const
Getter for azimuth angle.
Definition angles.cc:230
ns3::DoubleValue
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition ptr.h:66
ns3::TestCase::AddTestCase
void AddTestCase(TestCase *testCase, Duration duration=Duration::QUICK)
Add an individual child TestCase to this test suite.
Definition test.cc:292
ns3::TestCase::Duration::QUICK
@ QUICK
Fast test.
Definition test.h:1055
ns3::TestCase::TestCase
TestCase(const TestCase &)=delete
ns3::TestSuite::Type
Type
Type of test.
Definition test.h:1274
ns3::TestSuite::TestSuite
TestSuite(std::string name, Type type=Type::UNIT)
Construct a new test suite.
Definition test.cc:490
ns3::TestSuite::UNIT
static constexpr auto UNIT
Definition test.h:1291
ParabolicAntennaModelGainTestCondition
ParabolicAntennaModelGainTestCondition
Test condition (equal to or less than)
Definition test-parabolic-antenna.cc:30
EQUAL
@ EQUAL
Definition test-parabolic-antenna.cc:31
LESSTHAN
@ LESSTHAN
Definition test-parabolic-antenna.cc:32
EQUAL
@ EQUAL
Definition test-cosine-antenna.cc:31
LESSTHAN
@ LESSTHAN
Definition test-cosine-antenna.cc:32
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition log-macros-enabled.h:229
ns3::CreateObject
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Definition object.h:619
NS_TEST_EXPECT_MSG_LT
#define NS_TEST_EXPECT_MSG_LT(actual, limit, msg)
Test that an actual value is less than a limit and report if not.
Definition test.h:780
NS_TEST_EXPECT_MSG_EQ_TOL
#define NS_TEST_EXPECT_MSG_EQ_TOL(actual, limit, tol, msg)
Test that actual and expected (limit) values are equal to plus or minus some tolerance and report if ...
Definition test.h:500
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::DegreesToRadians
double DegreesToRadians(double degrees)
converts degrees to radians
Definition angles.cc:28
g_staticParabolicAntennaModelTestSuiteInstance
static ParabolicAntennaModelTestSuite g_staticParabolicAntennaModelTestSuiteInstance
Static variable for test initialization.
Definition test-parabolic-antenna.cc:583