ns3::SatStatsMarsalaCorrelationHelper Class Reference

#include "satellite-stats-marsala-correlation-helper.h"

+ Inheritance diagram for ns3::SatStatsMarsalaCorrelationHelper:
+ Collaboration diagram for ns3::SatStatsMarsalaCorrelationHelper:

Public Member Functions

 SatStatsMarsalaCorrelationHelper (Ptr< const SatHelper > satHelper)
 
virtual ~SatStatsMarsalaCorrelationHelper ()
 / Destructor. More...
 
void CorrelationRxCallback (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)
 
virtual void UpdateAddressAndIdentifier (Ptr< Node > utNode)
 Update the address and the proper identifier from the given UT node. More...
 
virtual void UpdateIdentifierOnProbes ()
 Change identifier used on probes, when handovers occur. More...
 

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...
 
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
 
virtual void SaveAddressAndIdentifier (Ptr< Node > utNode)
 Save the address and the proper identifier from the given UT node. More...
 

Private Attributes

Ptr< DataCollectionObject > m_aggregator
 The aggregator created by this helper. More...
 
SatPhyRxCarrier::CarrierType m_carrierType
 
CollectorMap m_terminalCollectors
 Maintains a list of collectors created by this helper. More...
 
std::string m_traceSourceName
 

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 > GetSatSatOrbiterNetDevice (Ptr< Node > satNode)
 
static Ptr< NetDevice > GetUtSatNetDevice (Ptr< Node > utNode)
 
- Protected Attributes inherited from ns3::SatStatsHelper
std::map< const Address, uint32_t > m_identifierMap
 Map of address and the identifier associated with it. More...
 

Detailed Description

Definition at line 47 of file satellite-stats-marsala-correlation-helper.h.

Constructor & Destructor Documentation

◆ SatStatsMarsalaCorrelationHelper()

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

Definition at line 59 of file satellite-stats-marsala-correlation-helper.cc.

References ns3::SatPhyRxCarrier::RA_CRDSA, SetTraceSourceName(), and SetValidCarrierType().

+ Here is the call graph for this function:

◆ ~SatStatsMarsalaCorrelationHelper()

ns3::SatStatsMarsalaCorrelationHelper::~SatStatsMarsalaCorrelationHelper ( )
virtual

/ Destructor.

Definition at line 67 of file satellite-stats-marsala-correlation-helper.cc.

Member Function Documentation

◆ CorrelationRxCallback()

void ns3::SatStatsMarsalaCorrelationHelper::CorrelationRxCallback ( uint32_t  nPackets,
const Address &  from,
bool  isCollided 
)

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

Parameters
nPacketsnumber of packets in the received packet burst.
fromthe source address of the packet.
isCollidedwhether a collision has occurred.

Definition at line 292 of file satellite-stats-marsala-correlation-helper.cc.

References ns3::SatStatsHelper::GetOutputType(), ns3::SatStatsHelper::GetOutputTypeName(), ns3::SatStatsHelper::m_identifierMap, m_terminalCollectors, ns3::SatStatsHelper::OUTPUT_SCALAR_FILE, ns3::SatStatsHelper::OUTPUT_SCALAR_PLOT, ns3::SatStatsHelper::OUTPUT_SCATTER_FILE, and ns3::SatStatsHelper::OUTPUT_SCATTER_PLOT.

Referenced by DoInstall().

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

◆ DoInstall()

◆ GetTraceSourceName()

std::string ns3::SatStatsMarsalaCorrelationHelper::GetTraceSourceName ( ) const
Returns

Definition at line 87 of file satellite-stats-marsala-correlation-helper.cc.

References m_traceSourceName.

Referenced by DoInstall().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

inherited from ObjectBase base class

Definition at line 73 of file satellite-stats-marsala-correlation-helper.cc.

◆ GetValidCarrierType()

SatPhyRxCarrier::CarrierType ns3::SatStatsMarsalaCorrelationHelper::GetValidCarrierType ( ) const
inline

Get the valid carrier type.

Returns
the valid carrier type

Definition at line 81 of file satellite-stats-marsala-correlation-helper.h.

References m_carrierType.

Referenced by DoInstall().

+ Here is the caller graph for this function:

◆ SetTraceSourceName()

void ns3::SatStatsMarsalaCorrelationHelper::SetTraceSourceName ( std::string  traceSourceName)
protected
Parameters
traceSourceName

Definition at line 80 of file satellite-stats-marsala-correlation-helper.cc.

References m_traceSourceName.

Referenced by SatStatsMarsalaCorrelationHelper().

+ Here is the caller graph for this function:

◆ SetValidCarrierType()

void ns3::SatStatsMarsalaCorrelationHelper::SetValidCarrierType ( SatPhyRxCarrier::CarrierType  carrierType)
inlineprotected

Set valid carrier type for this statistics helper type.

Parameters
carrierType

Definition at line 99 of file satellite-stats-marsala-correlation-helper.h.

References m_carrierType.

Referenced by SatStatsMarsalaCorrelationHelper().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_aggregator

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

The aggregator created by this helper.

Definition at line 109 of file satellite-stats-marsala-correlation-helper.h.

Referenced by DoInstall().

◆ m_carrierType

SatPhyRxCarrier::CarrierType ns3::SatStatsMarsalaCorrelationHelper::m_carrierType
private

◆ m_terminalCollectors

CollectorMap ns3::SatStatsMarsalaCorrelationHelper::m_terminalCollectors
private

Maintains a list of collectors created by this helper.

Definition at line 106 of file satellite-stats-marsala-correlation-helper.h.

Referenced by CorrelationRxCallback(), and DoInstall().

◆ m_traceSourceName

std::string ns3::SatStatsMarsalaCorrelationHelper::m_traceSourceName
private

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