A Discrete-Event Network Simulator
API
ns3::PhyTxStatsCalculator Class Reference

Takes care of storing the information generated at PHY layer regarding transmission. More...

#include "phy-tx-stats-calculator.h"

+ Inheritance diagram for ns3::PhyTxStatsCalculator:
+ Collaboration diagram for ns3::PhyTxStatsCalculator:

Public Member Functions

 PhyTxStatsCalculator ()
 Constructor. More...
 
virtual ~PhyTxStatsCalculator ()
 Destructor. More...
 
void DlPhyTransmission (PhyTransmissionStatParameters params)
 Notifies the stats calculator that an downlink transmission has occurred. More...
 
std::string GetDlTxOutputFilename (void)
 Get the name of the file where the DL TX PHY statistics will be stored. More...
 
std::string GetUlTxOutputFilename (void)
 Get the name of the file where the UL RX PHY statistics will be stored. More...
 
void SetDlTxOutputFilename (std::string outputFilename)
 Set the name of the file where the DL TX PHY statistics will be stored. More...
 
void SetUlTxOutputFilename (std::string outputFilename)
 Set the name of the file where the UL Tx PHY statistics will be stored. More...
 
void UlPhyTransmission (PhyTransmissionStatParameters params)
 Notifies the stats calculator that an uplink transmission has occurred. More...
 
- Public Member Functions inherited from ns3::LteStatsCalculator
 LteStatsCalculator ()
 Constructor. More...
 
virtual ~LteStatsCalculator ()
 Destructor. More...
 
bool ExistsCellIdPath (std::string path)
 Checks if there is an already stored cell id for the given path. More...
 
bool ExistsImsiPath (std::string path)
 Checks if there is an already stored IMSI for the given path. More...
 
uint16_t GetCellIdPath (std::string path)
 Retrieves the cell id information for the given path. More...
 
std::string GetDlOutputFilename (void)
 Get the name of the file where the downlink statistics will be stored. More...
 
uint64_t GetImsiPath (std::string path)
 Retrieves the imsi information for the given path. More...
 
std::string GetUlOutputFilename (void)
 Get the name of the file where the uplink statistics will be stored. More...
 
void SetCellIdPath (std::string path, uint16_t cellId)
 Stores the (path, cellId) pairs in a map. More...
 
void SetDlOutputFilename (std::string outputFilename)
 Set the name of the file where the downlink statistics will be stored. More...
 
void SetImsiPath (std::string path, uint64_t imsi)
 Stores the (path, imsi) pairs in a map. More...
 
void SetUlOutputFilename (std::string outputFilename)
 Set the name of the file where the uplink statistics will be stored. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static void DlPhyTransmissionCallback (Ptr< PhyTxStatsCalculator > phyTxStats, std::string path, PhyTransmissionStatParameters params)
 trace sink More...
 
static TypeId GetTypeId (void)
 Register this type. More...
 
static void UlPhyTransmissionCallback (Ptr< PhyTxStatsCalculator > phyTxStats, std::string path, PhyTransmissionStatParameters params)
 trace sink More...
 
- Static Public Member Functions inherited from ns3::LteStatsCalculator
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

bool m_dlTxFirstWrite
 When writing DL TX PHY statistics first time to file, columns description is added. More...
 
std::ofstream m_dlTxOutFile
 DL TX PHY statistics output trace file. More...
 
bool m_ulTxFirstWrite
 When writing UL TX PHY statistics first time to file, columns description is added. More...
 
std::ofstream m_ulTxOutFile
 UL TX PHY statistics output trace file. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Static Protected Member Functions inherited from ns3::LteStatsCalculator
static uint16_t FindCellIdFromEnbMac (std::string path, uint16_t rnti)
 Retrieves CellId from Enb MAC path in the attribute system. More...
 
static uint16_t FindCellIdFromEnbRlcPath (std::string path)
 Retrieves CellId from Enb RLC path in the attribute system. More...
 
static uint64_t FindImsiForEnb (std::string path, uint16_t rnti)
 Retrieves IMSI from path for Enb in the attribute system. More...
 
static uint64_t FindImsiForUe (std::string path, uint16_t rnti)
 Retrieves IMSI from path for Ue in the attribute system. More...
 
static uint64_t FindImsiFromEnbMac (std::string path, uint16_t rnti)
 Retrieves IMSI from Enb MAC path in the attribute system. More...
 
static uint64_t FindImsiFromEnbRlcPath (std::string path)
 Retrieves IMSI from Enb RLC path in the attribute system. More...
 
static uint64_t FindImsiFromLteNetDevice (std::string path)
 Retrieves IMSI from LteNetDevice path in the attribute system. More...
 
static uint64_t FindImsiFromUePhy (std::string path)
 Retrieves IMSI from Ue PHY path in the attribute system. More...
 

Detailed Description

Takes care of storing the information generated at PHY layer regarding transmission.

Introspection did not find any typical Config paths.

Metrics saved are:

  • Timestamp (in seconds)
  • Frame index
  • Subframe index
  • C-RNTI
  • MCS for transport block 1
  • Size of transport block 1
  • MCS for transport block 2 (0 if not used)
  • Size of transport block 2 (0 if not used)


Attributes

  • DlTxOutputFilename: Name of the file where the downlink results will be saved.
    • Set with class: StringValue
    • Underlying type:
    • Initial value: DlTxPhyStats.txt
    • Flags: construct write
  • UlTxOutputFilename: Name of the file where the uplink results will be saved.
    • Set with class: StringValue
    • Underlying type:
    • Initial value: UlTxPhyStats.txt
    • Flags: construct write

No TraceSources are defined for this type.
Size of this type is 1176 bytes (on a 64-bit architecture).

Definition at line 50 of file phy-tx-stats-calculator.h.

Constructor & Destructor Documentation

◆ PhyTxStatsCalculator()

ns3::PhyTxStatsCalculator::PhyTxStatsCalculator ( )

Constructor.

Definition at line 34 of file phy-tx-stats-calculator.cc.

References NS_LOG_FUNCTION.

◆ ~PhyTxStatsCalculator()

ns3::PhyTxStatsCalculator::~PhyTxStatsCalculator ( )
virtual

Destructor.

Definition at line 42 of file phy-tx-stats-calculator.cc.

References m_dlTxOutFile, m_ulTxOutFile, and NS_LOG_FUNCTION.

Member Function Documentation

◆ DlPhyTransmission()

◆ DlPhyTransmissionCallback()

void ns3::PhyTxStatsCalculator::DlPhyTransmissionCallback ( Ptr< PhyTxStatsCalculator phyTxStats,
std::string  path,
PhyTransmissionStatParameters  params 
)
static

trace sink

Parameters
phyTxStats
path
params

Definition at line 166 of file phy-tx-stats-calculator.cc.

References ns3::LteStatsCalculator::FindImsiFromEnbRlcPath(), ns3::PhyTransmissionStatParameters::m_imsi, ns3::PhyTransmissionStatParameters::m_rnti, and NS_LOG_FUNCTION.

Referenced by ns3::LteHelper::EnableDlTxPhyTraces().

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

◆ GetDlTxOutputFilename()

std::string ns3::PhyTxStatsCalculator::GetDlTxOutputFilename ( void  )

Get the name of the file where the DL TX PHY statistics will be stored.

Returns
the name of the file where the DL TX PHY statistics will be stored

Definition at line 95 of file phy-tx-stats-calculator.cc.

References ns3::LteStatsCalculator::GetDlOutputFilename().

Referenced by DlPhyTransmission().

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

◆ GetTypeId()

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

Register this type.

Returns
The object TypeId.

Definition at line 56 of file phy-tx-stats-calculator.cc.

References ns3::MakeStringAccessor(), ns3::MakeStringChecker(), SetDlTxOutputFilename(), ns3::TypeId::SetParent(), and SetUlTxOutputFilename().

+ Here is the call graph for this function:

◆ GetUlTxOutputFilename()

std::string ns3::PhyTxStatsCalculator::GetUlTxOutputFilename ( void  )

Get the name of the file where the UL RX PHY statistics will be stored.

Returns
the name of the file where the UL RX PHY statistics will be stored

Definition at line 83 of file phy-tx-stats-calculator.cc.

References ns3::LteStatsCalculator::GetUlOutputFilename().

Referenced by UlPhyTransmission().

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

◆ SetDlTxOutputFilename()

void ns3::PhyTxStatsCalculator::SetDlTxOutputFilename ( std::string  outputFilename)

Set the name of the file where the DL TX PHY statistics will be stored.

Parameters
outputFilenamestring with the name of the file

Definition at line 89 of file phy-tx-stats-calculator.cc.

References ns3::LteStatsCalculator::SetDlOutputFilename().

Referenced by GetTypeId().

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

◆ SetUlTxOutputFilename()

void ns3::PhyTxStatsCalculator::SetUlTxOutputFilename ( std::string  outputFilename)

Set the name of the file where the UL Tx PHY statistics will be stored.

Parameters
outputFilenamestring with the name of the file

Definition at line 77 of file phy-tx-stats-calculator.cc.

References ns3::LteStatsCalculator::SetUlOutputFilename().

Referenced by GetTypeId().

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

◆ UlPhyTransmission()

◆ UlPhyTransmissionCallback()

void ns3::PhyTxStatsCalculator::UlPhyTransmissionCallback ( Ptr< PhyTxStatsCalculator phyTxStats,
std::string  path,
PhyTransmissionStatParameters  params 
)
static

trace sink

Parameters
phyTxStats
path
params

Definition at line 189 of file phy-tx-stats-calculator.cc.

References ns3::LteStatsCalculator::FindImsiFromLteNetDevice(), ns3::PhyTransmissionStatParameters::m_imsi, ns3::PhyTransmissionStatParameters::m_rnti, and NS_LOG_FUNCTION.

Referenced by ns3::LteHelper::EnableUlTxPhyTraces().

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

Member Data Documentation

◆ m_dlTxFirstWrite

bool ns3::PhyTxStatsCalculator::m_dlTxFirstWrite
private

When writing DL TX PHY statistics first time to file, columns description is added.

Then next lines are appended to file. This value is true if output files have not been opened yet

Definition at line 136 of file phy-tx-stats-calculator.h.

Referenced by DlPhyTransmission().

◆ m_dlTxOutFile

std::ofstream ns3::PhyTxStatsCalculator::m_dlTxOutFile
private

DL TX PHY statistics output trace file.

Definition at line 149 of file phy-tx-stats-calculator.h.

Referenced by ~PhyTxStatsCalculator(), and DlPhyTransmission().

◆ m_ulTxFirstWrite

bool ns3::PhyTxStatsCalculator::m_ulTxFirstWrite
private

When writing UL TX PHY statistics first time to file, columns description is added.

Then next lines are appended to file. This value is true if output files have not been opened yet

Definition at line 144 of file phy-tx-stats-calculator.h.

Referenced by UlPhyTransmission().

◆ m_ulTxOutFile

std::ofstream ns3::PhyTxStatsCalculator::m_ulTxOutFile
private

UL TX PHY statistics output trace file.

Definition at line 154 of file phy-tx-stats-calculator.h.

Referenced by ~PhyTxStatsCalculator(), and UlPhyTransmission().


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