Base class for MODCOD statistics helpers. More...

#include "satellite-stats-link-modcod-helper.h"

Inheritance diagram for ns3::SatStatsLinkModcodHelper:

Collaboration diagram for ns3::SatStatsLinkModcodHelper:

Public Member Functions
	SatStatsLinkModcodHelper (Ptr< const SatHelper > satHelper)

virtual	~SatStatsLinkModcodHelper ()
	/ Destructor. More...

bool	GetAveragingMode () const

void	InstallProbes ()
	Set up several probes or other means of listeners and connect them to the collectors. More...

void	RxLinkModcodCallback (uint32_t modcod, const Address &from)
	Receive inputs from trace sources and determine the right collector to forward the inputs to. More...

void	SetAveragingMode (bool averagingMode)

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 SatHelper >	GetSatHelper () 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
bool	ConnectProbeToCollector (Ptr< Probe > probe, uint32_t identifier)
	Connect the probe to the right collector. More...

void	DoInstall ()
	Install the probes, collectors, and aggregators necessary to produce the statistics output. More...

virtual void	DoInstallProbes ()=0

void	PassSampleToCollector (uint32_t modcod, uint32_t identifier)
	Find a collector with the right identifier and pass a sample data to it. More...

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...

Ptr< DistributionCollector >	m_averagingCollector
	The final collector utilized in averaged output (histogram, PDF, and CDF). More...

std::map< const Address, uint32_t >	m_identifierMap
	Map of address and the identifier associated with it (for return link). More...

CollectorMap	m_terminalCollectors
	Maintains a list of collectors created by this helper. More...

Private Attributes
bool	m_averagingMode
	`AveragingMode` attribute. 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

Base class for MODCOD statistics helpers.

Definition at line 48 of file satellite-stats-link-modcod-helper.h.

Constructor & Destructor Documentation

◆ SatStatsLinkModcodHelper()

ns3::SatStatsLinkModcodHelper::SatStatsLinkModcodHelper ( Ptr< const SatHelper > satHelper )

Definition at line 61 of file satellite-stats-link-modcod-helper.cc.

◆ ~SatStatsLinkModcodHelper()

ns3::SatStatsLinkModcodHelper::~SatStatsLinkModcodHelper ( )

virtual

/ Destructor.

Definition at line 68 of file satellite-stats-link-modcod-helper.cc.

Member Function Documentation

◆ ConnectProbeToCollector()

bool ns3::SatStatsLinkModcodHelper::ConnectProbeToCollector	(	Ptr< Probe >	probe,
		uint32_t	identifier
	)

protected

Connect the probe to the right collector.

Parameters

probe
identifier

Definition at line 470 of file satellite-stats-link-modcod-helper.cc.

Here is the call graph for this function:

◆ DoInstall()

void ns3::SatStatsLinkModcodHelper::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.

Todo:: Find a better dataset name.

Todo:: Find a better dataset name.

Implements ns3::SatStatsHelper.

Definition at line 103 of file satellite-stats-link-modcod-helper.cc.

Here is the call graph for this function:

◆ DoInstallProbes()

virtual void ns3::SatStatsLinkModcodHelper::DoInstallProbes ( )

protectedpure virtual

Implemented in ns3::SatStatsRtnUserLinkModcodHelper, ns3::SatStatsRtnFeederLinkModcodHelper, ns3::SatStatsFwdUserLinkModcodHelper, and ns3::SatStatsFwdFeederLinkModcodHelper.

Referenced by InstallProbes().

Here is the caller graph for this function:

◆ GetAveragingMode()

bool ns3::SatStatsLinkModcodHelper::GetAveragingMode ( ) const

Returns: the currently active averaging mode.

Definition at line 97 of file satellite-stats-link-modcod-helper.cc.

References m_averagingMode.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SatStatsLinkModcodHelper::GetTypeId ( void )

static

inherited from ObjectBase base class

Definition at line 74 of file satellite-stats-link-modcod-helper.cc.

References GetAveragingMode(), and SetAveragingMode().

Here is the call graph for this function:

◆ InstallProbes()

void ns3::SatStatsLinkModcodHelper::InstallProbes ( )

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

Definition at line 409 of file satellite-stats-link-modcod-helper.cc.

References DoInstallProbes().

Referenced by DoInstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PassSampleToCollector()

void ns3::SatStatsLinkModcodHelper::PassSampleToCollector	(	uint32_t	modcod,
		uint32_t	identifier
	)

protected

Find a collector with the right identifier and pass a sample data to it.

Parameters

modcod
identifier

Definition at line 536 of file satellite-stats-link-modcod-helper.cc.

Referenced by RxLinkModcodCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RxLinkModcodCallback()

void ns3::SatStatsLinkModcodHelper::RxLinkModcodCallback	(	uint32_t	modcod,
		const Address &	from
	)

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

Parameters

modcod	MODCOD ID
from	the address of the sender of the packet.

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

Definition at line 416 of file satellite-stats-link-modcod-helper.cc.

References m_identifierMap, and PassSampleToCollector().

Referenced by ns3::SatStatsFwdFeederLinkModcodHelper::DoInstallProbes(), ns3::SatStatsFwdUserLinkModcodHelper::DoInstallProbes(), ns3::SatStatsRtnFeederLinkModcodHelper::DoInstallProbes(), and ns3::SatStatsRtnUserLinkModcodHelper::DoInstallProbes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveAddressAndIdentifier()

void ns3::SatStatsLinkModcodHelper::SaveAddressAndIdentifier ( Ptr< Node > utNode )

protected

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

Parameters

utNode a UT node.

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

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

Definition at line 450 of file satellite-stats-link-modcod-helper.cc.

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

Referenced by ns3::SatStatsFwdFeederLinkModcodHelper::DoInstallProbes(), ns3::SatStatsFwdUserLinkModcodHelper::DoInstallProbes(), ns3::SatStatsRtnFeederLinkModcodHelper::DoInstallProbes(), and ns3::SatStatsRtnUserLinkModcodHelper::DoInstallProbes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAveragingMode()

void ns3::SatStatsLinkModcodHelper::SetAveragingMode ( bool averagingMode )

Parameters

averagingMode average all samples before passing them to aggregator.

Definition at line 90 of file satellite-stats-link-modcod-helper.cc.

References m_averagingMode.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_aggregator

Ptr<DataCollectionObject> ns3::SatStatsLinkModcodHelper::m_aggregator

protected

The aggregator created by this helper.

Definition at line 134 of file satellite-stats-link-modcod-helper.h.

Referenced by DoInstall().

◆ m_averagingCollector

Ptr<DistributionCollector> ns3::SatStatsLinkModcodHelper::m_averagingCollector

protected

The final collector utilized in averaged output (histogram, PDF, and CDF).

Definition at line 131 of file satellite-stats-link-modcod-helper.h.

Referenced by DoInstall().

◆ m_averagingMode

bool ns3::SatStatsLinkModcodHelper::m_averagingMode

private

AveragingMode attribute.

Definition at line 140 of file satellite-stats-link-modcod-helper.h.

Referenced by ConnectProbeToCollector(), DoInstall(), GetAveragingMode(), PassSampleToCollector(), and SetAveragingMode().

◆ m_identifierMap

std::map<const Address, uint32_t> ns3::SatStatsLinkModcodHelper::m_identifierMap

protected

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

Definition at line 137 of file satellite-stats-link-modcod-helper.h.

Referenced by RxLinkModcodCallback(), and SaveAddressAndIdentifier().

◆ m_terminalCollectors

CollectorMap ns3::SatStatsLinkModcodHelper::m_terminalCollectors

protected

Maintains a list of collectors created by this helper.

Definition at line 128 of file satellite-stats-link-modcod-helper.h.

Referenced by ConnectProbeToCollector(), DoInstall(), and PassSampleToCollector().

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

/builds/sns3/satellite/satellite/stats/satellite-stats-link-modcod-helper.h
/builds/sns3/satellite/satellite/stats/satellite-stats-link-modcod-helper.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SatStatsLinkModcodHelper()

◆ ~SatStatsLinkModcodHelper()

Member Function Documentation

◆ ConnectProbeToCollector()

◆ DoInstall()

◆ DoInstallProbes()

◆ GetAveragingMode()

◆ GetTypeId()

◆ InstallProbes()

◆ PassSampleToCollector()

◆ RxLinkModcodCallback()

◆ SaveAddressAndIdentifier()

◆ SetAveragingMode()

Member Data Documentation

◆ m_aggregator

◆ m_averagingCollector

◆ m_averagingMode

◆ m_identifierMap

◆ m_terminalCollectors