ns3::SatStatsUserPacketCollisionHelper Class Reference

#include "satellite-stats-packet-collision-helper.h"

+ Inheritance diagram for ns3::SatStatsUserPacketCollisionHelper:
+ Collaboration diagram for ns3::SatStatsUserPacketCollisionHelper:

Public Member Functions

 SatStatsUserPacketCollisionHelper (Ptr< const SatHelper > satHelper)
 
virtual ~SatStatsUserPacketCollisionHelper ()
 / Destructor. More...
 
- Public Member Functions inherited from ns3::SatStatsPacketCollisionHelper
 SatStatsPacketCollisionHelper (Ptr< const SatHelper > satHelper)
 
virtual ~SatStatsPacketCollisionHelper ()
 / Destructor. More...
 
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. More...
 
std::string GetTraceSourceName () const
 
SatPhyRxCarrier::CarrierType GetValidCarrierType () const
 Get the valid carrier type. More...
 
- Public Member Functions inherited from ns3::SatStatsHelper
 SatStatsHelper (Ptr< const SatHelper > satHelper)
 Creates a new helper instance. More...
 
virtual ~SatStatsHelper ()
 / Destructor. More...
 
IdentifierType_t GetIdentifierType () const
 
std::string GetName () const
 
OutputType_t GetOutputType () const
 
Ptr< const SatHelperGetSatHelper () const
 
void Install ()
 Install the probes, collectors, and aggregators necessary to produce the statistics output. More...
 
bool IsInstalled () const
 
void SetIdentifierType (IdentifierType_t identifierType)
 
void SetName (std::string name)
 
void SetOutputType (OutputType_t outputType)
 

Static Public Member Functions

static TypeId GetTypeId ()
 inherited from ObjectBase base class More...
 
- Static Public Member Functions inherited from ns3::SatStatsPacketCollisionHelper
static TypeId GetTypeId ()
 inherited from ObjectBase base class More...
 
- Static Public Member Functions inherited from ns3::SatStatsHelper
static std::string GetIdentifierTypeName (IdentifierType_t identifierType)
 
static std::string GetOutputTypeName (OutputType_t outputType)
 
static TypeId GetTypeId ()
 inherited from ObjectBase base class More...
 

Protected Member Functions

void DoInstall ()
 Install the probes, collectors, and aggregators necessary to produce the statistics output. More...
 
- Protected Member Functions inherited from ns3::SatStatsPacketCollisionHelper
void SaveAddressAndIdentifier (Ptr< Node > utNode)
 Save the address and the proper identifier from the given UT node. More...
 
void SetTraceSourceName (std::string traceSourceName)
 
void SetValidCarrierType (SatPhyRxCarrier::CarrierType carrierType)
 Set valid carrier type for this statistics helper type. More...
 
- Protected Member Functions inherited from ns3::SatStatsHelper
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. More...
 
uint32_t CreateCollectorPerIdentifier (CollectorMap &collectorMap) const
 Create one collector instance for each identifier in the simulation. More...
 
virtual std::string GetDistributionHeading (std::string dataLabel) const
 
uint32_t GetGwId (Ptr< Node > gwNode) const
 
uint32_t GetIdentifierForBeam (uint32_t satId, uint32_t beamId) const
 
uint32_t GetIdentifierForGroup (uint32_t groupId) const
 
uint32_t GetIdentifierForGw (Ptr< Node > gwNode) const
 
uint32_t GetIdentifierForIsl (Ptr< Node > satNodeSrc, Ptr< Node > satNodeDst) const
 
uint32_t GetIdentifierForSat (Ptr< Node > satNode) const
 
uint32_t GetIdentifierForUt (Ptr< Node > utNode) const
 
uint32_t GetIdentifierForUtUser (Ptr< Node > utUserNode) const
 
virtual std::string GetIdentifierHeading (std::string dataLabel) const
 
virtual std::string GetOutputFileName () const
 Compute the path and file name where statistics output should be written to. More...
 
virtual std::string GetOutputPath () const
 
uint32_t GetSatId (Ptr< Node > satNode) const
 
virtual std::string GetTimeHeading (std::string dataLabel) const
 
uint32_t GetUtId (Ptr< Node > utNode) const
 
uint32_t GetUtUserId (Ptr< Node > utUserNode) const
 

Private Attributes

Ptr< DataCollectionObject > m_aggregator
 The aggregator created by this helper. More...
 

Additional Inherited Members

- Public Types inherited from ns3::SatStatsHelper
enum  IdentifierType_t {
  IDENTIFIER_GLOBAL = 0 , IDENTIFIER_GW , IDENTIFIER_BEAM , IDENTIFIER_UT ,
  IDENTIFIER_UT_USER , IDENTIFIER_SLICE , IDENTIFIER_GROUP , IDENTIFIER_SAT ,
  IDENTIFIER_ISL
}
 Possible categorization of statistics output. More...
 
enum  OutputType_t {
  OUTPUT_NONE = 0 , OUTPUT_SCALAR_FILE , OUTPUT_SCATTER_FILE , OUTPUT_HISTOGRAM_FILE ,
  OUTPUT_PDF_FILE , OUTPUT_CDF_FILE , OUTPUT_SCALAR_PLOT , OUTPUT_SCATTER_PLOT ,
  OUTPUT_HISTOGRAM_PLOT , OUTPUT_PDF_PLOT , OUTPUT_CDF_PLOT
}
 Possible types and formats of statistics output. More...
 
- Static Protected Member Functions inherited from ns3::SatStatsHelper
static NetDeviceContainer GetGwSatNetDevice (Ptr< Node > gwNode)
 
static Ptr< NetDevice > GetSatSatGeoNetDevice (Ptr< Node > satNode)
 
static Ptr< NetDevice > GetUtSatNetDevice (Ptr< Node > utNode)
 
- Protected Attributes inherited from ns3::SatStatsPacketCollisionHelper
std::map< const Address, uint32_t > m_identifierMap
 Map of address and the identifier associated with it (for forward link). More...
 
CollectorMap m_terminalCollectors
 Maintains a list of collectors created by this helper. More...
 

Detailed Description

Definition at line 160 of file satellite-stats-packet-collision-helper.h.

Constructor & Destructor Documentation

◆ SatStatsUserPacketCollisionHelper()

ns3::SatStatsUserPacketCollisionHelper::SatStatsUserPacketCollisionHelper ( Ptr< const SatHelper satHelper)

Definition at line 390 of file satellite-stats-packet-collision-helper.cc.

◆ ~SatStatsUserPacketCollisionHelper()

ns3::SatStatsUserPacketCollisionHelper::~SatStatsUserPacketCollisionHelper ( )
virtual

/ Destructor.

Definition at line 396 of file satellite-stats-packet-collision-helper.cc.

Member Function Documentation

◆ DoInstall()

void ns3::SatStatsUserPacketCollisionHelper::DoInstall ( )
protectedvirtual

Install the probes, collectors, and aggregators necessary to produce the statistics output.

An abstract method of SatStatsHelper which must be implemented by child classes. It will be invoked by Install().

Todo:
Add support for boxes in Gnuplot.

Implements ns3::SatStatsHelper.

Definition at line 410 of file satellite-stats-packet-collision-helper.cc.

References ns3::SatStatsPacketCollisionHelper::CollisionRxCallback(), ns3::SatStatsHelper::CreateAggregator(), ns3::SatStatsHelper::CreateCollectorPerIdentifier(), ns3::SatStatsHelper::GetIdentifierHeading(), ns3::SatStatsHelper::GetName(), ns3::SatStatsHelper::GetOutputFileName(), ns3::SatStatsHelper::GetOutputPath(), ns3::SatStatsHelper::GetOutputType(), ns3::SatStatsHelper::GetOutputTypeName(), ns3::SatStatsHelper::GetSatHelper(), ns3::SatStatsHelper::GetSatSatGeoNetDevice(), ns3::SatStatsHelper::GetTimeHeading(), ns3::SatStatsPacketCollisionHelper::GetTraceSourceName(), ns3::SatStatsPacketCollisionHelper::GetValidCarrierType(), m_aggregator, ns3::SatStatsPacketCollisionHelper::m_terminalCollectors, ns3::SatStatsHelper::OUTPUT_CDF_FILE, ns3::SatStatsHelper::OUTPUT_CDF_PLOT, ns3::SatStatsHelper::OUTPUT_HISTOGRAM_FILE, ns3::SatStatsHelper::OUTPUT_HISTOGRAM_PLOT, ns3::SatStatsHelper::OUTPUT_NONE, ns3::SatStatsHelper::OUTPUT_PDF_FILE, ns3::SatStatsHelper::OUTPUT_PDF_PLOT, ns3::SatStatsHelper::OUTPUT_SCALAR_FILE, ns3::SatStatsHelper::OUTPUT_SCALAR_PLOT, ns3::SatStatsHelper::OUTPUT_SCATTER_FILE, ns3::SatStatsHelper::OUTPUT_SCATTER_PLOT, and ns3::SatStatsPacketCollisionHelper::SaveAddressAndIdentifier().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::SatStatsUserPacketCollisionHelper::GetTypeId ( void  )
static

inherited from ObjectBase base class

Definition at line 402 of file satellite-stats-packet-collision-helper.cc.

Member Data Documentation

◆ m_aggregator

Ptr<DataCollectionObject> ns3::SatStatsUserPacketCollisionHelper::m_aggregator
private

The aggregator created by this helper.

Definition at line 182 of file satellite-stats-packet-collision-helper.h.

Referenced by DoInstall().


The documentation for this class was generated from the following files: