ns3::SatStatsSignallingLoadHelper Class Referenceabstract

Abstract class inherited by SatStatsFwdSignallingLoadHelper and SatStatsRtnSignallingLoadHelper. More...

#include "satellite-stats-signalling-load-helper.h"

+ Inheritance diagram for ns3::SatStatsSignallingLoadHelper:
+ Collaboration diagram for ns3::SatStatsSignallingLoadHelper:

Public Member Functions

 SatStatsSignallingLoadHelper (Ptr< const SatHelper > satHelper)
 
virtual ~SatStatsSignallingLoadHelper ()
 / Destructor. More...
 
void InstallProbes ()
 Set up several probes or other means of listeners and connect them to the first-level collectors. More...
 
void SignallingTxCallback (Ptr< const Packet > packet, const Address &to)
 Receive inputs from trace sources and determine the right collector to forward the inputs to. 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::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...
 
virtual void DoInstallProbes ()=0
 
void SaveAddressAndIdentifier (Ptr< Node > utNode)
 Save the address and the proper identifier from the given UT node. 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
 

Protected Attributes

Ptr< DataCollectionObject > m_aggregator
 The aggregator created by this helper. More...
 
CollectorMap m_conversionCollectors
 Maintains a list of first-level collectors created by this helper. More...
 
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 second-level collectors 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)
 

Detailed Description

Constructor & Destructor Documentation

◆ SatStatsSignallingLoadHelper()

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

Definition at line 54 of file satellite-stats-signalling-load-helper.cc.

◆ ~SatStatsSignallingLoadHelper()

ns3::SatStatsSignallingLoadHelper::~SatStatsSignallingLoadHelper ( )
virtual

/ Destructor.

Definition at line 60 of file satellite-stats-signalling-load-helper.cc.

Member Function Documentation

◆ DoInstall()

◆ DoInstallProbes()

virtual void ns3::SatStatsSignallingLoadHelper::DoInstallProbes ( )
protectedpure virtual

Implemented in ns3::SatStatsRtnSignallingLoadHelper, and ns3::SatStatsFwdSignallingLoadHelper.

Referenced by InstallProbes().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

inherited from ObjectBase base class

Definition at line 66 of file satellite-stats-signalling-load-helper.cc.

◆ InstallProbes()

void ns3::SatStatsSignallingLoadHelper::InstallProbes ( )

Set up several probes or other means of listeners and connect them to the first-level collectors.

Definition at line 222 of file satellite-stats-signalling-load-helper.cc.

References DoInstallProbes().

Referenced by DoInstall().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SaveAddressAndIdentifier()

void ns3::SatStatsSignallingLoadHelper::SaveAddressAndIdentifier ( Ptr< Node >  utNode)
protected

Save the address and the proper identifier from the given UT node.

Parameters
utNodea UT node.

The address of the given node will be saved in the m_identifierMap member variable.

Used in forward link statistics. DoInstallProbes() is expected to pass the the UT node of interest into this method.

Definition at line 290 of file satellite-stats-signalling-load-helper.cc.

References ns3::SatStatsHelper::GetIdentifierForUt(), ns3::SatIdMapper::GetUtMacWithNode(), and m_identifierMap.

Referenced by ns3::SatStatsFwdSignallingLoadHelper::DoInstallProbes().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SignallingTxCallback()

void ns3::SatStatsSignallingLoadHelper::SignallingTxCallback ( Ptr< const Packet >  packet,
const Address &  to 
)

Receive inputs from trace sources and determine the right collector to forward the inputs to.

Parameters
packetcontrol message packet transmitted.
tothe destination address of the packet.

Used in return link statistics. DoInstallProbes() is expected to connect the right trace sources to this method.

Definition at line 231 of file satellite-stats-signalling-load-helper.cc.

References m_conversionCollectors, and m_identifierMap.

Referenced by ns3::SatStatsFwdSignallingLoadHelper::DoInstallProbes().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_aggregator

Ptr<DataCollectionObject> ns3::SatStatsSignallingLoadHelper::m_aggregator
protected

The aggregator created by this helper.

Definition at line 109 of file satellite-stats-signalling-load-helper.h.

Referenced by DoInstall().

◆ m_conversionCollectors

CollectorMap ns3::SatStatsSignallingLoadHelper::m_conversionCollectors
protected

Maintains a list of first-level collectors created by this helper.

Definition at line 103 of file satellite-stats-signalling-load-helper.h.

Referenced by DoInstall(), ns3::SatStatsRtnSignallingLoadHelper::DoInstallProbes(), and SignallingTxCallback().

◆ m_identifierMap

std::map<const Address, uint32_t> ns3::SatStatsSignallingLoadHelper::m_identifierMap
protected

Map of address and the identifier associated with it (for forward link).

Definition at line 112 of file satellite-stats-signalling-load-helper.h.

Referenced by SaveAddressAndIdentifier(), and SignallingTxCallback().

◆ m_terminalCollectors

CollectorMap ns3::SatStatsSignallingLoadHelper::m_terminalCollectors
protected

Maintains a list of second-level collectors created by this helper.

Definition at line 106 of file satellite-stats-signalling-load-helper.h.

Referenced by DoInstall().


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