Base class for packet error statistics helpers. More...

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

Inheritance diagram for ns3::SatStatsPacketErrorHelper:

Collaboration diagram for ns3::SatStatsPacketErrorHelper:

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

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

void	ErrorRxCallback (uint32_t nPackets, const Address &fromOrTo, bool isError)
	Receive inputs from trace sources and determine the right collector to forward the inputs to. More...

SatEnums::ChannelType_t	GetChannelType () const

std::string	GetTraceSourceName () const

SatPhyRxCarrier::CarrierType	GetValidCarrierType () const
	Get the valid carrier type. More...

void	SetChannelType (SatEnums::ChannelType_t channelType)

void	SetTraceSourceName (std::string traceSourceName)

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
void	DoInstall ()
	Install the probes, collectors, and aggregators necessary to produce the statistics output. More...

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 Member Functions
void	InstallProbeOnGw (Ptr< Node > gwNode)
	Set up several listeners on a GW node and connect them to the collectors. More...

void	InstallProbeOnSatFeeder (Ptr< Node > satNode)
	Set up several listeners on a SAT feeder node and connect them to the collectors. More...

void	InstallProbeOnSatUser (Ptr< Node > satNode)
	Set up several listeners on a SAT user node and connect them to the collectors. More...

void	InstallProbeOnUt (Ptr< Node > utNode)
	Set up several probes on a UT node and connect them to the collectors. More...

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
	Valid carrier type. More...

SatEnums::ChannelType_t	m_channelType
	Link where statistics are gathered from. More...

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

std::list< Ptr< Probe > >	m_probes
	Maintains a list of probes created by this helper (for forward link). More...

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

std::string	m_traceSourceName
	Name of trace source of PHY RX carrier to listen to. 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 packet error statistics helpers.

Definition at line 48 of file satellite-stats-packet-error-helper.h.

Constructor & Destructor Documentation

◆ SatStatsPacketErrorHelper()

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

Definition at line 58 of file satellite-stats-packet-error-helper.cc.

◆ ~SatStatsPacketErrorHelper()

ns3::SatStatsPacketErrorHelper::~SatStatsPacketErrorHelper ( )

virtual

/ Destructor.

Definition at line 66 of file satellite-stats-packet-error-helper.cc.

Member Function Documentation

◆ DoInstall()

void ns3::SatStatsPacketErrorHelper::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 105 of file satellite-stats-packet-error-helper.cc.

Here is the call graph for this function:

◆ ErrorRxCallback()

void ns3::SatStatsPacketErrorHelper::ErrorRxCallback	(	uint32_t	nPackets,
		const Address &	fromOrTo,
		bool	isError
	)

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

Parameters

nPackets	number of packets in the received packet burst.
fromOrTo	the source or destination address of the packet.
isError	whether a PHY error has occurred.

Used only in return link.

Definition at line 304 of file satellite-stats-packet-error-helper.cc.

References ns3::SatStatsHelper::GetOutputType(), ns3::SatStatsHelper::GetOutputTypeName(), 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 InstallProbeOnGw(), InstallProbeOnSatFeeder(), and InstallProbeOnSatUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannelType()

SatEnums::ChannelType_t ns3::SatStatsPacketErrorHelper::GetChannelType ( ) const

Returns: link where statistics are gathered from.

Definition at line 99 of file satellite-stats-packet-error-helper.cc.

References m_channelType.

◆ GetTraceSourceName()

std::string ns3::SatStatsPacketErrorHelper::GetTraceSourceName ( ) const

Returns: name of trace source of PHY RX carrier to listen to.

Definition at line 86 of file satellite-stats-packet-error-helper.cc.

References m_traceSourceName.

Referenced by InstallProbeOnGw(), InstallProbeOnSatFeeder(), InstallProbeOnSatUser(), and InstallProbeOnUt().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SatStatsPacketErrorHelper::GetTypeId ( void )

static

inherited from ObjectBase base class

Definition at line 72 of file satellite-stats-packet-error-helper.cc.

◆ GetValidCarrierType()

SatPhyRxCarrier::CarrierType ns3::SatStatsPacketErrorHelper::GetValidCarrierType ( ) const

inline

Get the valid carrier type.

Returns: the valid carrier type

Definition at line 99 of file satellite-stats-packet-error-helper.h.

References m_carrierType.

Referenced by InstallProbeOnGw(), InstallProbeOnSatFeeder(), InstallProbeOnSatUser(), and InstallProbeOnUt().

Here is the caller graph for this function:

◆ InstallProbeOnGw()

void ns3::SatStatsPacketErrorHelper::InstallProbeOnGw ( Ptr< Node > gwNode )

private

Set up several listeners on a GW node and connect them to the collectors.

Parameters

gwNode

Definition at line 419 of file satellite-stats-packet-error-helper.cc.

References ErrorRxCallback(), ns3::SatStatsHelper::GetGwSatNetDevice(), GetTraceSourceName(), and GetValidCarrierType().

Referenced by DoInstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallProbeOnSatFeeder()

void ns3::SatStatsPacketErrorHelper::InstallProbeOnSatFeeder ( Ptr< Node > satNode )

private

Set up several listeners on a SAT feeder node and connect them to the collectors.

Parameters

satNode

Definition at line 472 of file satellite-stats-packet-error-helper.cc.

References ErrorRxCallback(), ns3::SatStatsHelper::GetSatSatGeoNetDevice(), GetTraceSourceName(), and GetValidCarrierType().

Referenced by DoInstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallProbeOnSatUser()

void ns3::SatStatsPacketErrorHelper::InstallProbeOnSatUser ( Ptr< Node > satNode )

private

Set up several listeners on a SAT user node and connect them to the collectors.

Parameters

satNode

Definition at line 530 of file satellite-stats-packet-error-helper.cc.

References ErrorRxCallback(), ns3::SatStatsHelper::GetSatSatGeoNetDevice(), GetTraceSourceName(), and GetValidCarrierType().

Referenced by DoInstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallProbeOnUt()

void ns3::SatStatsPacketErrorHelper::InstallProbeOnUt ( Ptr< Node > utNode )

private

Set up several probes on a UT node and connect them to the collectors.

Parameters

utNode

Definition at line 588 of file satellite-stats-packet-error-helper.cc.

References ns3::SatStatsHelper::GetIdentifierForUt(), ns3::SatStatsHelper::GetOutputType(), ns3::SatStatsHelper::GetOutputTypeName(), GetTraceSourceName(), ns3::SatStatsHelper::GetUtId(), ns3::SatStatsHelper::GetUtSatNetDevice(), GetValidCarrierType(), m_probes, 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:

◆ SaveAddressAndIdentifier()

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

private

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 only in return link.

Definition at line 399 of file satellite-stats-packet-error-helper.cc.

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

Referenced by DoInstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetChannelType()

void ns3::SatStatsPacketErrorHelper::SetChannelType ( SatEnums::ChannelType_t channelType )

Parameters

channelType link where statistics are gathered from.

Definition at line 92 of file satellite-stats-packet-error-helper.cc.

References ns3::SatEnums::GetChannelTypeName(), and m_channelType.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTraceSourceName()

void ns3::SatStatsPacketErrorHelper::SetTraceSourceName ( std::string traceSourceName )

Parameters

traceSourceName name of trace source of PHY RX carrier to listen to.

Definition at line 79 of file satellite-stats-packet-error-helper.cc.

References m_traceSourceName.

Here is the caller graph for this function:

◆ SetValidCarrierType()

void ns3::SatStatsPacketErrorHelper::SetValidCarrierType ( SatPhyRxCarrier::CarrierType carrierType )

inlineprotected

Set valid carrier type for this statistics helper type.

Parameters

carrierType

Definition at line 112 of file satellite-stats-packet-error-helper.h.

References m_carrierType.

Here is the caller graph for this function:

Member Data Documentation

◆ m_aggregator

Ptr<DataCollectionObject> ns3::SatStatsPacketErrorHelper::m_aggregator

private

The aggregator created by this helper.

Definition at line 162 of file satellite-stats-packet-error-helper.h.

Referenced by DoInstall().

◆ m_carrierType

SatPhyRxCarrier::CarrierType ns3::SatStatsPacketErrorHelper::m_carrierType

private

Valid carrier type.

Definition at line 174 of file satellite-stats-packet-error-helper.h.

Referenced by GetValidCarrierType(), and SetValidCarrierType().

◆ m_channelType

SatEnums::ChannelType_t ns3::SatStatsPacketErrorHelper::m_channelType

private

Link where statistics are gathered from.

Definition at line 171 of file satellite-stats-packet-error-helper.h.

Referenced by DoInstall(), GetChannelType(), and SetChannelType().

◆ m_identifierMap

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

private

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

Definition at line 165 of file satellite-stats-packet-error-helper.h.

Referenced by ErrorRxCallback(), and SaveAddressAndIdentifier().

◆ m_probes

std::list<Ptr<Probe> > ns3::SatStatsPacketErrorHelper::m_probes

private

Maintains a list of probes created by this helper (for forward link).

Definition at line 156 of file satellite-stats-packet-error-helper.h.

Referenced by InstallProbeOnUt().

◆ m_terminalCollectors

CollectorMap ns3::SatStatsPacketErrorHelper::m_terminalCollectors

private

Maintains a list of collectors created by this helper.

Definition at line 159 of file satellite-stats-packet-error-helper.h.

Referenced by DoInstall(), ErrorRxCallback(), and InstallProbeOnUt().

◆ m_traceSourceName

std::string ns3::SatStatsPacketErrorHelper::m_traceSourceName

private

Name of trace source of PHY RX carrier to listen to.

Definition at line 168 of file satellite-stats-packet-error-helper.h.

Referenced by GetTraceSourceName(), and SetTraceSourceName().

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

/builds/sns3/satellite/satellite/stats/satellite-stats-packet-error-helper.h
/builds/sns3/satellite/satellite/stats/satellite-stats-packet-error-helper.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SatStatsPacketErrorHelper()

◆ ~SatStatsPacketErrorHelper()

Member Function Documentation

◆ DoInstall()

◆ ErrorRxCallback()

◆ GetChannelType()

◆ GetTraceSourceName()

◆ GetTypeId()

◆ GetValidCarrierType()

◆ InstallProbeOnGw()

◆ InstallProbeOnSatFeeder()

◆ InstallProbeOnSatUser()

◆ InstallProbeOnUt()

◆ SaveAddressAndIdentifier()

◆ SetChannelType()

◆ SetTraceSourceName()

◆ SetValidCarrierType()

Member Data Documentation

◆ m_aggregator

◆ m_carrierType

◆ m_channelType

◆ m_identifierMap

◆ m_probes

◆ m_terminalCollectors

◆ m_traceSourceName