Loading...
Searching...
No Matches
satellite-stats-packet-collision-helper.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2014 Magister Solutions
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Budiarto Herman <budiarto.herman@magister.fi>
19 *
20 */
21
22#include "satellite-stats-packet-collision-helper.h"
23
24#include "ns3/boolean.h"
25#include "ns3/callback.h"
26#include "ns3/data-collection-object.h"
27#include "ns3/enum.h"
28#include "ns3/interval-rate-collector.h"
29#include "ns3/log.h"
30#include "ns3/mac48-address.h"
31#include "ns3/magister-gnuplot-aggregator.h"
32#include "ns3/multi-file-aggregator.h"
33#include "ns3/node-container.h"
34#include "ns3/object-vector.h"
35#include "ns3/satellite-helper.h"
36#include "ns3/satellite-id-mapper.h"
37#include "ns3/satellite-net-device.h"
38#include "ns3/satellite-orbiter-net-device.h"
39#include "ns3/satellite-phy-rx-carrier.h"
40#include "ns3/satellite-phy-rx.h"
41#include "ns3/satellite-phy.h"
42#include "ns3/satellite-topology.h"
43#include "ns3/scalar-collector.h"
44#include "ns3/singleton.h"
45#include "ns3/string.h"
46
47#include <map>
48#include <sstream>
49#include <string>
50
51NS_LOG_COMPONENT_DEFINE("SatStatsPacketCollisionHelper");
52
53namespace ns3
54{
55
56// BASE CLASS /////////////////////////////////////////////////////////////////
57
58NS_OBJECT_ENSURE_REGISTERED(SatStatsPacketCollisionHelper);
59
60SatStatsPacketCollisionHelper::SatStatsPacketCollisionHelper(Ptr<const SatHelper> satHelper)
61 : SatStatsHelper(satHelper)
62{
63 NS_LOG_FUNCTION(this << satHelper);
64}
65
70
71TypeId // static
72SatStatsPacketCollisionHelper::GetTypeId()
73{
74 static TypeId tid = TypeId("ns3::SatStatsPacketCollisionHelper").SetParent<SatStatsHelper>();
75 return tid;
76}
77
78void
79SatStatsPacketCollisionHelper::SetTraceSourceName(std::string traceSourceName)
80{
81 NS_LOG_FUNCTION(this << traceSourceName);
82 m_traceSourceName = traceSourceName;
83}
84
85std::string
90
91void
92SatStatsPacketCollisionHelper::CollisionRxCallback(uint32_t nPackets,
93 const Address& from,
94 bool isCollided)
95{
96 NS_LOG_FUNCTION(this << nPackets << from << isCollided);
97
98 if (from.IsInvalid())
99 {
100 NS_LOG_WARN(this << " discarding " << nPackets << " packets"
101 << " from statistics collection because of" << " invalid sender address");
102 }
103 else
104 {
105 // Determine the identifier associated with the sender address.
106 std::map<const Address, uint32_t>::const_iterator it = m_identifierMap.find(from);
107
108 if (it == m_identifierMap.end())
109 {
110 NS_LOG_WARN(this << " discarding " << nPackets << " packets"
111 << " from statistics collection because of"
112 << " unknown sender address " << from);
113 }
114 else
115 {
116 // Find the first-level collector with the right identifier.
117 Ptr<DataCollectionObject> collector = m_terminalCollectors.Get(it->second);
118 NS_ASSERT_MSG(collector != nullptr,
119 "Unable to find collector with identifier " << it->second);
120
121 switch (GetOutputType())
122 {
123 case SatStatsHelper::OUTPUT_SCALAR_FILE:
124 case SatStatsHelper::OUTPUT_SCALAR_PLOT: {
125 Ptr<ScalarCollector> c = collector->GetObject<ScalarCollector>();
126 NS_ASSERT(c != nullptr);
127 c->TraceSinkBoolean(false, isCollided);
128 break;
129 }
130
131 case SatStatsHelper::OUTPUT_SCATTER_FILE:
132 case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
133 Ptr<IntervalRateCollector> c = collector->GetObject<IntervalRateCollector>();
134 NS_ASSERT(c != nullptr);
135 c->TraceSinkBoolean(false, isCollided);
136 break;
137 }
138
139 default:
140 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
141 << " is not a valid output type for this statistics.");
142 break;
143
144 } // end of `switch (GetOutputType ())`
145
146 } // end of else of `if (it == m_identifierMap.end ())`
147
148 } // end of else of `if (from.IsInvalid ())`
149
150} // end of `void CollisionRxCallback (uint32_t, const Address &, bool);`
151
152// BASE CLASS FEEDER /////////////////////////////////////////////////////////////////
153
154NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederPacketCollisionHelper);
155
156SatStatsFeederPacketCollisionHelper::SatStatsFeederPacketCollisionHelper(
157 Ptr<const SatHelper> satHelper)
158 : SatStatsPacketCollisionHelper(satHelper)
159{
160 NS_LOG_FUNCTION(this << satHelper);
161}
162
167
168TypeId // static
169SatStatsFeederPacketCollisionHelper::GetTypeId()
170{
171 static TypeId tid = TypeId("ns3::SatStatsFeederPacketCollisionHelper")
172 .SetParent<SatStatsPacketCollisionHelper>();
173 return tid;
174}
175
176void
177SatStatsFeederPacketCollisionHelper::DoInstall()
178{
179 NS_LOG_FUNCTION(this);
180
181 switch (GetOutputType())
182 {
183 case SatStatsHelper::OUTPUT_NONE:
184 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
185 << " is not a valid output type for this statistics.");
186 break;
187
188 case SatStatsHelper::OUTPUT_SCALAR_FILE: {
189 // Setup aggregator.
190 m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
191 "OutputFileName",
192 StringValue(GetOutputFileName()),
193 "MultiFileMode",
194 BooleanValue(false),
195 "EnableContextPrinting",
196 BooleanValue(true),
197 "GeneralHeading",
198 StringValue(GetIdentifierHeading("collision_rate")));
199
200 // Setup collectors.
201 m_terminalCollectors.SetType("ns3::ScalarCollector");
202 m_terminalCollectors.SetAttribute("InputDataType",
203 EnumValue(ScalarCollector::INPUT_DATA_TYPE_BOOLEAN));
204 m_terminalCollectors.SetAttribute(
205 "OutputType",
206 EnumValue(ScalarCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
207 CreateCollectorPerIdentifier(m_terminalCollectors);
208 m_terminalCollectors.ConnectToAggregator("Output",
209 m_aggregator,
210 &MultiFileAggregator::Write1d);
211 break;
212 }
213
214 case SatStatsHelper::OUTPUT_SCATTER_FILE: {
215 // Setup aggregator.
216 m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
217 "OutputFileName",
218 StringValue(GetOutputFileName()),
219 "GeneralHeading",
220 StringValue(GetTimeHeading("collision_rate")));
221
222 // Setup collectors.
223 m_terminalCollectors.SetType("ns3::IntervalRateCollector");
224 m_terminalCollectors.SetAttribute(
225 "InputDataType",
226 EnumValue(IntervalRateCollector::INPUT_DATA_TYPE_BOOLEAN));
227 m_terminalCollectors.SetAttribute(
228 "OutputType",
229 EnumValue(IntervalRateCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
230 CreateCollectorPerIdentifier(m_terminalCollectors);
231 m_terminalCollectors.ConnectToAggregator("OutputWithTime",
232 m_aggregator,
233 &MultiFileAggregator::Write2d);
234 m_terminalCollectors.ConnectToAggregator("OutputString",
235 m_aggregator,
236 &MultiFileAggregator::AddContextHeading);
237 break;
238 }
239
240 case SatStatsHelper::OUTPUT_HISTOGRAM_FILE:
241 case SatStatsHelper::OUTPUT_PDF_FILE:
242 case SatStatsHelper::OUTPUT_CDF_FILE:
243 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
244 << " is not a valid output type for this statistics.");
245 break;
246
247 case SatStatsHelper::OUTPUT_SCALAR_PLOT:
249 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
250 << " is not a valid output type for this statistics.");
251 break;
252
253 case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
254 // Setup aggregator.
255 m_aggregator = CreateAggregator("ns3::MagisterGnuplotAggregator",
256 "OutputPath",
257 StringValue(GetOutputPath()),
258 "OutputFileName",
259 StringValue(GetName()));
260 Ptr<MagisterGnuplotAggregator> plotAggregator =
261 m_aggregator->GetObject<MagisterGnuplotAggregator>();
262 NS_ASSERT(plotAggregator != nullptr);
263 // plot->SetTitle ("");
264 plotAggregator->SetLegend("Time (in seconds)", "Packet collision rate");
265 plotAggregator->Set2dDatasetDefaultStyle(Gnuplot2dDataset::LINES);
266
267 // Setup collectors.
268 m_terminalCollectors.SetType("ns3::IntervalRateCollector");
269 m_terminalCollectors.SetAttribute(
270 "InputDataType",
271 EnumValue(IntervalRateCollector::INPUT_DATA_TYPE_BOOLEAN));
272 m_terminalCollectors.SetAttribute(
273 "OutputType",
274 EnumValue(IntervalRateCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
275 CreateCollectorPerIdentifier(m_terminalCollectors);
276 for (CollectorMap::Iterator it = m_terminalCollectors.Begin();
277 it != m_terminalCollectors.End();
278 ++it)
279 {
280 const std::string context = it->second->GetName();
281 plotAggregator->Add2dDataset(context, context);
282 }
283 m_terminalCollectors.ConnectToAggregator("OutputWithTime",
284 m_aggregator,
285 &MagisterGnuplotAggregator::Write2d);
286 break;
287 }
288
289 case SatStatsHelper::OUTPUT_HISTOGRAM_PLOT:
290 case SatStatsHelper::OUTPUT_PDF_PLOT:
291 case SatStatsHelper::OUTPUT_CDF_PLOT:
292 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
293 << " is not a valid output type for this statistics.");
294 break;
295
296 default:
297 NS_FATAL_ERROR("SatStatsUserPacketCollisionHelper - Invalid output type");
298 break;
299 }
300
301 // Create a map of UT addresses and identifiers.
302 NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
303 for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
304 {
305 SaveAddressAndIdentifier(*it);
306 }
307
308 // Connect to trace sources at GW nodes.
309
310 NodeContainer gws = Singleton<SatTopology>::Get()->GetGwNodes();
311 Callback<void, uint32_t, const Address&, bool> callback =
312 MakeCallback(&SatStatsFeederPacketCollisionHelper::CollisionRxCallback, this);
313
314 for (NodeContainer::Iterator it = gws.Begin(); it != gws.End(); ++it)
315 {
316 NetDeviceContainer devs = GetGwSatNetDevice(*it);
317
318 for (NetDeviceContainer::Iterator itDev = devs.Begin(); itDev != devs.End(); ++itDev)
319 {
320 Ptr<SatNetDevice> satDev = (*itDev)->GetObject<SatNetDevice>();
321 NS_ASSERT(satDev != nullptr);
322 Ptr<SatPhy> satPhy = satDev->GetPhy();
323 NS_ASSERT(satPhy != nullptr);
324 Ptr<SatPhyRx> satPhyRx = satPhy->GetPhyRx();
325 NS_ASSERT(satPhyRx != nullptr);
326 ObjectVectorValue carriers;
327 satPhyRx->GetAttribute("RxCarrierList", carriers);
328 NS_LOG_DEBUG(this << " Node ID " << (*it)->GetId() << " device #"
329 << (*itDev)->GetIfIndex() << " has " << carriers.GetN()
330 << " RX carriers");
331
332 for (ObjectVectorValue::Iterator itCarrier = carriers.Begin();
333 itCarrier != carriers.End();
334 ++itCarrier)
335 {
336 SatPhyRxCarrier::CarrierType ct =
337 DynamicCast<SatPhyRxCarrier>(itCarrier->second)->GetCarrierType();
338 if (ct != GetValidCarrierType())
339 {
340 continue;
341 }
342
343 const bool ret =
344 itCarrier->second->TraceConnectWithoutContext(GetTraceSourceName(), callback);
345 if (ret)
346 {
347 NS_LOG_INFO(this << " successfully connected with node ID " << (*it)->GetId()
348 << " device #" << (*itDev)->GetIfIndex() << " RX carrier #"
349 << itCarrier->first);
350 }
351 else
352 {
353 NS_FATAL_ERROR("Error connecting to "
354 << GetTraceSourceName() << " trace source"
355 << " of SatPhyRxCarrier" << " at node ID " << (*it)->GetId()
356 << " device #" << (*itDev)->GetIfIndex() << " RX carrier #"
357 << itCarrier->first);
358 }
359
360 } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
361
362 } // end of `for (NetDeviceContainer::Iterator itDev = devs)`
363
364 } // end of `for (NodeContainer::Iterator it = gws)`
365
366} // end of `void DoInstall ();`
367
368// BASE CLASS USER /////////////////////////////////////////////////////////////////
369
370NS_OBJECT_ENSURE_REGISTERED(SatStatsUserPacketCollisionHelper);
371
372SatStatsUserPacketCollisionHelper::SatStatsUserPacketCollisionHelper(Ptr<const SatHelper> satHelper)
373 : SatStatsPacketCollisionHelper(satHelper)
374{
375 NS_LOG_FUNCTION(this << satHelper);
376}
377
382
383TypeId // static
384SatStatsUserPacketCollisionHelper::GetTypeId()
385{
386 static TypeId tid =
387 TypeId("ns3::SatStatsUserPacketCollisionHelper").SetParent<SatStatsPacketCollisionHelper>();
388 return tid;
389}
390
391void
392SatStatsUserPacketCollisionHelper::DoInstall()
393{
394 NS_LOG_FUNCTION(this);
395
396 switch (GetOutputType())
397 {
398 case SatStatsHelper::OUTPUT_NONE:
399 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
400 << " is not a valid output type for this statistics.");
401 break;
402
403 case SatStatsHelper::OUTPUT_SCALAR_FILE: {
404 // Setup aggregator.
405 m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
406 "OutputFileName",
407 StringValue(GetOutputFileName()),
408 "MultiFileMode",
409 BooleanValue(false),
410 "EnableContextPrinting",
411 BooleanValue(true),
412 "GeneralHeading",
413 StringValue(GetIdentifierHeading("collision_rate")));
414
415 // Setup collectors.
416 m_terminalCollectors.SetType("ns3::ScalarCollector");
417 m_terminalCollectors.SetAttribute("InputDataType",
418 EnumValue(ScalarCollector::INPUT_DATA_TYPE_BOOLEAN));
419 m_terminalCollectors.SetAttribute(
420 "OutputType",
421 EnumValue(ScalarCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
422 CreateCollectorPerIdentifier(m_terminalCollectors);
423 m_terminalCollectors.ConnectToAggregator("Output",
424 m_aggregator,
425 &MultiFileAggregator::Write1d);
426 break;
427 }
428
429 case SatStatsHelper::OUTPUT_SCATTER_FILE: {
430 // Setup aggregator.
431 m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
432 "OutputFileName",
433 StringValue(GetOutputFileName()),
434 "GeneralHeading",
435 StringValue(GetTimeHeading("collision_rate")));
436
437 // Setup collectors.
438 m_terminalCollectors.SetType("ns3::IntervalRateCollector");
439 m_terminalCollectors.SetAttribute(
440 "InputDataType",
441 EnumValue(IntervalRateCollector::INPUT_DATA_TYPE_BOOLEAN));
442 m_terminalCollectors.SetAttribute(
443 "OutputType",
444 EnumValue(IntervalRateCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
445 CreateCollectorPerIdentifier(m_terminalCollectors);
446 m_terminalCollectors.ConnectToAggregator("OutputWithTime",
447 m_aggregator,
448 &MultiFileAggregator::Write2d);
449 m_terminalCollectors.ConnectToAggregator("OutputString",
450 m_aggregator,
451 &MultiFileAggregator::AddContextHeading);
452 break;
453 }
454
455 case SatStatsHelper::OUTPUT_HISTOGRAM_FILE:
456 case SatStatsHelper::OUTPUT_PDF_FILE:
457 case SatStatsHelper::OUTPUT_CDF_FILE:
458 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
459 << " is not a valid output type for this statistics.");
460 break;
461
462 case SatStatsHelper::OUTPUT_SCALAR_PLOT:
464 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
465 << " is not a valid output type for this statistics.");
466 break;
467
468 case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
469 // Setup aggregator.
470 m_aggregator = CreateAggregator("ns3::MagisterGnuplotAggregator",
471 "OutputPath",
472 StringValue(GetOutputPath()),
473 "OutputFileName",
474 StringValue(GetName()));
475 Ptr<MagisterGnuplotAggregator> plotAggregator =
476 m_aggregator->GetObject<MagisterGnuplotAggregator>();
477 NS_ASSERT(plotAggregator != nullptr);
478 // plot->SetTitle ("");
479 plotAggregator->SetLegend("Time (in seconds)", "Packet collision rate");
480 plotAggregator->Set2dDatasetDefaultStyle(Gnuplot2dDataset::LINES);
481
482 // Setup collectors.
483 m_terminalCollectors.SetType("ns3::IntervalRateCollector");
484 m_terminalCollectors.SetAttribute(
485 "InputDataType",
486 EnumValue(IntervalRateCollector::INPUT_DATA_TYPE_BOOLEAN));
487 m_terminalCollectors.SetAttribute(
488 "OutputType",
489 EnumValue(IntervalRateCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
490 CreateCollectorPerIdentifier(m_terminalCollectors);
491 for (CollectorMap::Iterator it = m_terminalCollectors.Begin();
492 it != m_terminalCollectors.End();
493 ++it)
494 {
495 const std::string context = it->second->GetName();
496 plotAggregator->Add2dDataset(context, context);
497 }
498 m_terminalCollectors.ConnectToAggregator("OutputWithTime",
499 m_aggregator,
500 &MagisterGnuplotAggregator::Write2d);
501 break;
502 }
503
504 case SatStatsHelper::OUTPUT_HISTOGRAM_PLOT:
505 case SatStatsHelper::OUTPUT_PDF_PLOT:
506 case SatStatsHelper::OUTPUT_CDF_PLOT:
507 NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
508 << " is not a valid output type for this statistics.");
509 break;
510
511 default:
512 NS_FATAL_ERROR("SatStatsFeederPacketCollisionHelper - Invalid output type");
513 break;
514 }
515
516 // Create a map of UT addresses and identifiers.
517 NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
518 for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
519 {
520 SaveAddressAndIdentifier(*it);
521 }
522
523 // Connect to trace sources at SAT nodes.
524
525 NodeContainer sats = Singleton<SatTopology>::Get()->GetOrbiterNodes();
526 Callback<void, uint32_t, const Address&, bool> callback =
527 MakeCallback(&SatStatsUserPacketCollisionHelper::CollisionRxCallback, this);
528
529 for (NodeContainer::Iterator it = sats.Begin(); it != sats.End(); ++it)
530 {
531 Ptr<NetDevice> dev = GetSatSatOrbiterNetDevice(*it);
532
533 Ptr<SatPhy> satPhy;
534 Ptr<SatOrbiterNetDevice> satOrbiterDev = dev->GetObject<SatOrbiterNetDevice>();
535 NS_ASSERT(satOrbiterDev != nullptr);
536 std::map<uint32_t, Ptr<SatPhy>> satOrbiterUserPhys = satOrbiterDev->GetUserPhy();
537 for (std::map<uint32_t, Ptr<SatPhy>>::iterator itPhy = satOrbiterUserPhys.begin();
538 itPhy != satOrbiterUserPhys.end();
539 ++itPhy)
540 {
541 satPhy = itPhy->second;
542 NS_ASSERT(satPhy != nullptr);
543 Ptr<SatPhyRx> satPhyRx = satPhy->GetPhyRx();
544 NS_ASSERT(satPhyRx != nullptr);
545
546 ObjectVectorValue carriers;
547 satPhyRx->GetAttribute("RxCarrierList", carriers);
548 NS_LOG_DEBUG(this << " Node ID " << (*it)->GetId() << " device #" << dev->GetIfIndex()
549 << " has " << carriers.GetN() << " RX carriers");
550
551 for (ObjectVectorValue::Iterator itCarrier = carriers.Begin();
552 itCarrier != carriers.End();
553 ++itCarrier)
554 {
555 SatPhyRxCarrier::CarrierType ct =
556 DynamicCast<SatPhyRxCarrier>(itCarrier->second)->GetCarrierType();
557 if (ct != GetValidCarrierType())
558 {
559 continue;
560 }
561
562 const bool ret =
563 itCarrier->second->TraceConnectWithoutContext(GetTraceSourceName(), callback);
564 if (ret)
565 {
566 NS_LOG_INFO(this << " successfully connected with node ID " << (*it)->GetId()
567 << " device #" << dev->GetIfIndex() << " RX carrier #"
568 << itCarrier->first);
569 }
570 else
571 {
572 NS_FATAL_ERROR("Error connecting to " << GetTraceSourceName() << " trace source"
573 << " of SatPhyRxCarrier" << " at node ID "
574 << (*it)->GetId() << " device #"
575 << dev->GetIfIndex() << " RX carrier #"
576 << itCarrier->first);
577 }
578
579 } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
580
581 } // end of `for (std::map<uint32_t, Ptr<SatPhy>>::iterator itPhy = satOrbiterUserPhys)`
582
583 } // end of `for (NodeContainer::Iterator it = sats)`
584
585} // end of `void DoInstall ();`
586
587// SLOTTED ALOHA FEEDER //////////////////////////////////////////////////////////////
588
589NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederSlottedAlohaPacketCollisionHelper);
590
591SatStatsFeederSlottedAlohaPacketCollisionHelper::SatStatsFeederSlottedAlohaPacketCollisionHelper(
592 Ptr<const SatHelper> satHelper)
593 : SatStatsFeederPacketCollisionHelper(satHelper)
594{
595 NS_LOG_FUNCTION(this << satHelper);
596 SetTraceSourceName("SlottedAlohaRxCollision");
597 SetValidCarrierType(SatPhyRxCarrier::RA_SLOTTED_ALOHA);
598}
599
604
605TypeId // static
606SatStatsFeederSlottedAlohaPacketCollisionHelper::GetTypeId()
607{
608 static TypeId tid = TypeId("ns3::SatStatsFeederSlottedAlohaPacketCollisionHelper")
609 .SetParent<SatStatsFeederPacketCollisionHelper>();
610 return tid;
611}
612
613// CRDSA FEEDER //////////////////////////////////////////////////////////////////////
614
615NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederCrdsaPacketCollisionHelper);
616
617SatStatsFeederCrdsaPacketCollisionHelper::SatStatsFeederCrdsaPacketCollisionHelper(
618 Ptr<const SatHelper> satHelper)
619 : SatStatsFeederPacketCollisionHelper(satHelper)
620{
621 NS_LOG_FUNCTION(this << satHelper);
622 SetTraceSourceName("CrdsaReplicaRx");
623 SetValidCarrierType(SatPhyRxCarrier::RA_CRDSA);
624}
625
630
631TypeId // static
632SatStatsFeederCrdsaPacketCollisionHelper::GetTypeId()
633{
634 static TypeId tid = TypeId("ns3::SatStatsFeederCrdsaPacketCollisionHelper")
635 .SetParent<SatStatsFeederPacketCollisionHelper>();
636 return tid;
637}
638
639// E-SSA FEEDER //////////////////////////////////////////////////////////////
640
641NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederEssaPacketCollisionHelper);
642
643SatStatsFeederEssaPacketCollisionHelper::SatStatsFeederEssaPacketCollisionHelper(
644 Ptr<const SatHelper> satHelper)
645 : SatStatsFeederPacketCollisionHelper(satHelper)
646{
647 NS_LOG_FUNCTION(this << satHelper);
648 SetTraceSourceName("EssaRxCollision");
649 SetValidCarrierType(SatPhyRxCarrier::RA_ESSA);
650}
651
656
657TypeId // static
658SatStatsFeederEssaPacketCollisionHelper::GetTypeId()
659{
660 static TypeId tid = TypeId("ns3::SatStatsFeederEssaPacketCollisionHelper")
661 .SetParent<SatStatsFeederPacketCollisionHelper>();
662 return tid;
663}
664
665// SLOTTED ALOHA USER //////////////////////////////////////////////////////////////
666
667NS_OBJECT_ENSURE_REGISTERED(SatStatsUserSlottedAlohaPacketCollisionHelper);
668
669SatStatsUserSlottedAlohaPacketCollisionHelper::SatStatsUserSlottedAlohaPacketCollisionHelper(
670 Ptr<const SatHelper> satHelper)
671 : SatStatsUserPacketCollisionHelper(satHelper)
672{
673 NS_LOG_FUNCTION(this << satHelper);
674 SetTraceSourceName("SlottedAlohaRxCollision");
675 SetValidCarrierType(SatPhyRxCarrier::RA_SLOTTED_ALOHA);
676}
677
682
683TypeId // static
684SatStatsUserSlottedAlohaPacketCollisionHelper::GetTypeId()
685{
686 static TypeId tid = TypeId("ns3::SatStatsUserSlottedAlohaPacketCollisionHelper")
687 .SetParent<SatStatsUserPacketCollisionHelper>();
688 return tid;
689}
690
691// CRDSA USER //////////////////////////////////////////////////////////////////////
692
693NS_OBJECT_ENSURE_REGISTERED(SatStatsUserCrdsaPacketCollisionHelper);
694
695SatStatsUserCrdsaPacketCollisionHelper::SatStatsUserCrdsaPacketCollisionHelper(
696 Ptr<const SatHelper> satHelper)
697 : SatStatsUserPacketCollisionHelper(satHelper)
698{
699 NS_LOG_FUNCTION(this << satHelper);
700 SetTraceSourceName("CrdsaReplicaRx");
701 SetValidCarrierType(SatPhyRxCarrier::RA_CRDSA);
702}
703
708
709TypeId // static
710SatStatsUserCrdsaPacketCollisionHelper::GetTypeId()
711{
712 static TypeId tid = TypeId("ns3::SatStatsUserCrdsaPacketCollisionHelper")
713 .SetParent<SatStatsUserPacketCollisionHelper>();
714 return tid;
715}
716
717// E-SSA USER //////////////////////////////////////////////////////////////
718
719NS_OBJECT_ENSURE_REGISTERED(SatStatsUserEssaPacketCollisionHelper);
720
721SatStatsUserEssaPacketCollisionHelper::SatStatsUserEssaPacketCollisionHelper(
722 Ptr<const SatHelper> satHelper)
723 : SatStatsUserPacketCollisionHelper(satHelper)
724{
725 NS_LOG_FUNCTION(this << satHelper);
726 SetTraceSourceName("EssaRxCollision");
727 SetValidCarrierType(SatPhyRxCarrier::RA_ESSA);
728}
729
734
735TypeId // static
736SatStatsUserEssaPacketCollisionHelper::GetTypeId()
737{
738 static TypeId tid = TypeId("ns3::SatStatsUserEssaPacketCollisionHelper")
739 .SetParent<SatStatsUserPacketCollisionHelper>();
740 return tid;
741}
742
743} // end of namespace ns3
ns3::SatNetDevice
SatNetDevice to be utilized in the UT and GW nodes.
Definition satellite-net-device.h:52
ns3::SatOrbiterNetDevice
SatOrbiterNetDevice to be utilized in geostationary satellite.
Definition satellite-orbiter-net-device.h:58
ns3::SatPhyRxCarrier::CarrierType
CarrierType
Possible carrier types.
Definition satellite-phy-rx-carrier.h:156
ns3::SatStatsFeederCrdsaPacketCollisionHelper
Produce packet collision statistics of Random Access CRDSA from a satellite module simulation.
Definition satellite-stats-packet-collision-helper.h:232
ns3::SatStatsFeederCrdsaPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:632
ns3::SatStatsFeederEssaPacketCollisionHelper
Produce packet collision statistics of Random Access E-SSA from a satellite module simulation.
Definition satellite-stats-packet-collision-helper.h:267
ns3::SatStatsFeederEssaPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:658
ns3::SatStatsFeederPacketCollisionHelper::m_aggregator
Ptr< DataCollectionObject > m_aggregator
The aggregator created by this helper.
Definition satellite-stats-packet-collision-helper.h:140
ns3::SatStatsFeederPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:169
ns3::SatStatsFeederPacketCollisionHelper::DoInstall
void DoInstall()
Install the probes, collectors, and aggregators necessary to produce the statistics output.
Definition satellite-stats-packet-collision-helper.cc:177
ns3::SatStatsFeederSlottedAlohaPacketCollisionHelper
Produce packet collision statistics of Random Access Slotted ALOHA from a satellite module simulation...
Definition satellite-stats-packet-collision-helper.h:196
ns3::SatStatsHelper::GetSatSatOrbiterNetDevice
static Ptr< NetDevice > GetSatSatOrbiterNetDevice(Ptr< Node > satNode)
Definition satellite-stats-helper.cc:1062
ns3::SatStatsHelper::GetGwSatNetDevice
static NetDeviceContainer GetGwSatNetDevice(Ptr< Node > gwNode)
Definition satellite-stats-helper.cc:1019
ns3::SatStatsHelper::SaveAddressAndIdentifier
virtual void SaveAddressAndIdentifier(Ptr< Node > utNode)
Save the address and the proper identifier from the given UT node.
Definition satellite-stats-helper.cc:1076
ns3::SatStatsHelper::GetOutputTypeName
static std::string GetOutputTypeName(OutputType_t outputType)
Definition satellite-stats-helper.cc:90
ns3::SatStatsHelper::SatStatsHelper
SatStatsHelper(Ptr< const SatHelper > satHelper)
Creates a new helper instance.
Definition satellite-stats-helper.cc:125
ns3::SatStatsHelper::GetIdentifierHeading
virtual std::string GetIdentifierHeading(std::string dataLabel) const
Definition satellite-stats-helper.cc:494
ns3::SatStatsHelper::GetOutputPath
virtual std::string GetOutputPath() const
Definition satellite-stats-helper.cc:482
ns3::SatStatsHelper::CreateAggregator
Ptr< DataCollectionObject > CreateAggregator(std::string aggregatorTypeId, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue())
Create the aggregator according to the output type.
Definition satellite-stats-helper.cc:301
ns3::SatStatsHelper::GetOutputFileName
virtual std::string GetOutputFileName() const
Compute the path and file name where statistics output should be written to.
Definition satellite-stats-helper.cc:488
ns3::SatStatsHelper::CreateCollectorPerIdentifier
uint32_t CreateCollectorPerIdentifier(CollectorMap &collectorMap) const
Create one collector instance for each identifier in the simulation.
Definition satellite-stats-helper.cc:327
ns3::SatStatsHelper::GetOutputType
OutputType_t GetOutputType() const
Definition satellite-stats-helper.cc:283
ns3::SatStatsHelper::m_identifierMap
std::map< const Address, uint32_t > m_identifierMap
Map of address and the identifier associated with it.
Definition satellite-stats-helper.h:422
ns3::SatStatsHelper::GetName
std::string GetName() const
Definition satellite-stats-helper.cc:237
ns3::SatStatsHelper::GetTimeHeading
virtual std::string GetTimeHeading(std::string dataLabel) const
Definition satellite-stats-helper.cc:533
ns3::SatStatsPacketCollisionHelper::CollisionRxCallback
void CollisionRxCallback(uint32_t nPackets, const Address &from, bool isCollided)
Receive inputs from trace sources and determine the right collector to forward the inputs to.
Definition satellite-stats-packet-collision-helper.cc:92
ns3::SatStatsPacketCollisionHelper::SetValidCarrierType
void SetValidCarrierType(SatPhyRxCarrier::CarrierType carrierType)
Set valid carrier type for this statistics helper type.
Definition satellite-stats-packet-collision-helper.h:97
ns3::SatStatsPacketCollisionHelper::SatStatsPacketCollisionHelper
SatStatsPacketCollisionHelper(Ptr< const SatHelper > satHelper)
Definition satellite-stats-packet-collision-helper.cc:60
ns3::SatStatsPacketCollisionHelper::GetValidCarrierType
SatPhyRxCarrier::CarrierType GetValidCarrierType() const
Get the valid carrier type.
Definition satellite-stats-packet-collision-helper.h:82
ns3::SatStatsPacketCollisionHelper::m_terminalCollectors
CollectorMap m_terminalCollectors
Maintains a list of collectors created by this helper.
Definition satellite-stats-packet-collision-helper.h:103
ns3::SatStatsPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:72
ns3::SatStatsUserCrdsaPacketCollisionHelper
Produce packet collision statistics of Random Access CRDSA from a satellite module simulation.
Definition satellite-stats-packet-collision-helper.h:338
ns3::SatStatsUserCrdsaPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:710
ns3::SatStatsUserEssaPacketCollisionHelper
Produce packet collision statistics of Random Access E-SSA from a satellite module simulation.
Definition satellite-stats-packet-collision-helper.h:373
ns3::SatStatsUserEssaPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:736
ns3::SatStatsUserPacketCollisionHelper::DoInstall
void DoInstall()
Install the probes, collectors, and aggregators necessary to produce the statistics output.
Definition satellite-stats-packet-collision-helper.cc:392
ns3::SatStatsUserPacketCollisionHelper::m_aggregator
Ptr< DataCollectionObject > m_aggregator
The aggregator created by this helper.
Definition satellite-stats-packet-collision-helper.h:172
ns3::SatStatsUserPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:384
ns3::SatStatsUserSlottedAlohaPacketCollisionHelper
Produce packet collision statistics of Random Access Slotted ALOHA from a satellite module simulation...
Definition satellite-stats-packet-collision-helper.h:303
ns3::SatStatsUserSlottedAlohaPacketCollisionHelper::GetTypeId
static TypeId GetTypeId()
inherited from ObjectBase base class
Definition satellite-stats-packet-collision-helper.cc:684
ns3
SatArqSequenceNumber is handling the sequence numbers for the ARQ process.
Definition sat-link-results-plot.cc:41