ns3::SatStatsRtnQueueHelper Class Reference

Helper for return link queue statistics. More...

#include "satellite-stats-queue-helper.h"

+ Inheritance diagram for ns3::SatStatsRtnQueueHelper:
+ Collaboration diagram for ns3::SatStatsRtnQueueHelper:

Public Member Functions

 SatStatsRtnQueueHelper (Ptr< const SatHelper > satHelper)
 
virtual ~SatStatsRtnQueueHelper ()
 / Destructor. More...
 
- Public Member Functions inherited from ns3::SatStatsQueueHelper
 SatStatsQueueHelper (Ptr< const SatHelper > satHelper)
 
virtual ~SatStatsQueueHelper ()
 / Destructor. More...
 
void EnlistSource ()
 Identify the list of source of queue events. More...
 
Time GetPollInterval () const
 
UnitType_t GetUnitType () const
 
void Poll ()
 Retrieve the queue size of every relevant encapsulator and push the values to the right collectors. More...
 
void SetPollInterval (Time pollInterval)
 
void SetUnitType (UnitType_t unitType)
 
- 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::SatStatsQueueHelper
static TypeId GetTypeId ()
 inherited from ObjectBase base class More...
 
static std::string GetUnitTypeName (UnitType_t unitType)
 
- 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 DoEnlistSource ()
 
void DoPoll ()
 Retrieve the queue size of every relevant encapsulator and push the values to the right collectors. More...
 
- Protected Member Functions inherited from ns3::SatStatsQueueHelper
void DoInstall ()
 Install the probes, collectors, and aggregators necessary to produce the statistics output. More...
 
void PushToCollector (uint32_t identifier, uint32_t value)
 
- 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

std::list< std::pair< Ptr< SatLlc >, uint32_t > > m_llc
 Maintains a list of UT LLC and its identifier. More...
 

Additional Inherited Members

- Public Types inherited from ns3::SatStatsQueueHelper
enum  UnitType_t { UNIT_BYTES = 0 , UNIT_NUMBER_OF_PACKETS }
 
- 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::SatStatsQueueHelper
Ptr< DataCollectionObject > m_aggregator
 The aggregator created by this helper. More...
 
CollectorMap m_terminalCollectors
 Maintains a list of collectors created by this helper. More...
 

Detailed Description

Helper for return link queue statistics.

Base class for return link.

Definition at line 232 of file satellite-stats-queue-helper.h.

Constructor & Destructor Documentation

◆ SatStatsRtnQueueHelper()

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

Definition at line 566 of file satellite-stats-queue-helper.cc.

◆ ~SatStatsRtnQueueHelper()

ns3::SatStatsRtnQueueHelper::~SatStatsRtnQueueHelper ( )
virtual

/ Destructor.

Definition at line 572 of file satellite-stats-queue-helper.cc.

Member Function Documentation

◆ DoEnlistSource()

void ns3::SatStatsRtnQueueHelper::DoEnlistSource ( )
protectedvirtual

◆ DoPoll()

void ns3::SatStatsRtnQueueHelper::DoPoll ( )
protectedvirtual

Retrieve the queue size of every relevant encapsulator and push the values to the right collectors.

Implements ns3::SatStatsQueueHelper.

Definition at line 604 of file satellite-stats-queue-helper.cc.

References ns3::SatStatsQueueHelper::GetUnitType(), m_llc, ns3::SatStatsQueueHelper::PushToCollector(), ns3::SatStatsQueueHelper::UNIT_BYTES, and ns3::SatStatsQueueHelper::UNIT_NUMBER_OF_PACKETS.

+ Here is the call graph for this function:

◆ GetTypeId()

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

inherited from ObjectBase base class

Definition at line 578 of file satellite-stats-queue-helper.cc.

Member Data Documentation

◆ m_llc

std::list<std::pair<Ptr<SatLlc>, uint32_t> > ns3::SatStatsRtnQueueHelper::m_llc
private

Maintains a list of UT LLC and its identifier.

Definition at line 255 of file satellite-stats-queue-helper.h.

Referenced by DoEnlistSource(), and DoPoll().


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