Loading...
Searching...
No Matches
ns3::SatStatsFrameSymbolLoadHelper Class Reference

Helper for frame symbol load statistics. More...

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

Inheritance diagram for ns3::SatStatsFrameSymbolLoadHelper:
Collaboration diagram for ns3::SatStatsFrameSymbolLoadHelper:

Public Member Functions

 SatStatsFrameSymbolLoadHelper (Ptr< const SatHelper > satHelper)
virtual ~SatStatsFrameSymbolLoadHelper ()
 / Destructor.
Public Member Functions inherited from ns3::SatStatsFrameLoadHelper
 SatStatsFrameLoadHelper (Ptr< const SatHelper > satHelper)
virtual ~SatStatsFrameLoadHelper ()
 / Destructor.
UnitType_t GetUnitType () const
void SetUnitType (UnitType_t unitType)
Public Member Functions inherited from ns3::SatStatsHelper
 SatStatsHelper (Ptr< const SatHelper > satHelper)
 Creates a new helper instance.
virtual ~SatStatsHelper ()
 / Destructor.
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.
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.
virtual void UpdateIdentifierOnProbes ()
 Change identifier used on probes, when handovers occur.

Static Public Member Functions

static TypeId GetTypeId ()
 inherited from ObjectBase base class
Static Public Member Functions inherited from ns3::SatStatsFrameLoadHelper
static TypeId GetTypeId ()
 inherited from ObjectBase base class
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

Additional Inherited Members

Public Types inherited from ns3::SatStatsFrameLoadHelper
enum  UnitType_t { UNIT_SYMBOLS = 0 , UNIT_USERS }
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...
Protected Member Functions inherited from ns3::SatStatsFrameLoadHelper
void DoInstall ()
 Install the probes, collectors, and aggregators necessary to produce the statistics output.
std::string GetIdentifierHeading (std::string dataLabel) const
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.
uint32_t CreateCollectorPerIdentifier (CollectorMap &collectorMap) const
 Create one collector instance for each identifier in the simulation.
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 GetOutputFileName () const
 Compute the path and file name where statistics output should be written to.
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.
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.

Detailed Description

Helper for frame symbol load statistics.

Definition at line 186 of file satellite-stats-frame-load-helper.h.

Constructor & Destructor Documentation

◆ SatStatsFrameSymbolLoadHelper()

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

◆ ~SatStatsFrameSymbolLoadHelper()

ns3::SatStatsFrameSymbolLoadHelper::~SatStatsFrameSymbolLoadHelper ( )
virtual

/ Destructor.

Definition at line 379 of file satellite-stats-frame-load-helper.cc.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::SatStatsFrameSymbolLoadHelper::GetTypeId ( )
static

inherited from ObjectBase base class

Definition at line 385 of file satellite-stats-frame-load-helper.cc.

References ns3::SatStatsFrameLoadHelper::SatStatsFrameLoadHelper().

Here is the call graph for this function:

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