ns3::NrBearerStatsCalculator Class Reference

#include "nr-bearer-stats-calculator.h"

Inheritance diagram for ns3::NrBearerStatsCalculator:

Collaboration diagram for ns3::NrBearerStatsCalculator:

Public Member Functions
	NrBearerStatsCalculator ()
	NrBearerStatsCalculator (std::string protocolType)
	~NrBearerStatsCalculator () override
void	DlRxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize, uint64_t delay) override
void	DlTxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize) override
void	DoDispose () override
uint32_t	GetDlCellId (uint64_t imsi, uint8_t lcid)
double	GetDlDelay (uint64_t imsi, uint8_t lcid)
std::vector< double >	GetDlDelayStats (uint64_t imsi, uint8_t lcid)
std::string	GetDlOutputFilename ()
std::vector< double >	GetDlPduSizeStats (uint64_t imsi, uint8_t lcid)
uint64_t	GetDlRxData (uint64_t imsi, uint8_t lcid)
uint32_t	GetDlRxPackets (uint64_t imsi, uint8_t lcid)
uint64_t	GetDlTxData (uint64_t imsi, uint8_t lcid)
uint32_t	GetDlTxPackets (uint64_t imsi, uint8_t lcid)
Time	GetEpoch () const
Time	GetStartTime () const
uint32_t	GetUlCellId (uint64_t imsi, uint8_t lcid)
double	GetUlDelay (uint64_t imsi, uint8_t lcid)
std::vector< double >	GetUlDelayStats (uint64_t imsi, uint8_t lcid)
std::string	GetUlOutputFilename ()
std::vector< double >	GetUlPduSizeStats (uint64_t imsi, uint8_t lcid)
uint64_t	GetUlRxData (uint64_t imsi, uint8_t lcid)
uint32_t	GetUlRxPackets (uint64_t imsi, uint8_t lcid)
uint64_t	GetUlTxData (uint64_t imsi, uint8_t lcid)
uint32_t	GetUlTxPackets (uint64_t imsi, uint8_t lcid)
void	SetEpoch (Time e)
void	SetStartTime (Time t)
void	UlRxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize, uint64_t delay) override
void	UlTxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize) override
Public Member Functions inherited from ns3::NrBearerStatsBase
void	DoDispose () override

Static Public Member Functions
static TypeId	GetTypeId ()
Static Public Member Functions inherited from ns3::NrBearerStatsBase
static TypeId	GetTypeId ()

Detailed Description

This class is an ns-3 trace sink that performs the calculation of RLC and PDCP statistics for uplink and downlink.

Statistics are generated on a per radio bearer basis.

The statistics are calculated at consecutive time windows and periodically written to a file. The calculated statistics are:

• Number of transmitted PDUs
• Number of received PDUs
• Number of transmitted bytes
• Number of received bytes
• Average, min, max and standard deviation of PDU delay (delay is calculated from the generation of the PDU to its reception)
• Average, min, max and standard deviation of PDU size

Introspection did not find any typical Config paths.

Attributes

• StartTime: Start time of the on going epoch.
  • Set with class: ns3::TimeValue
  • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
  • Initial value: +0ns
  • Flags: construct write read
• EpochDuration: Epoch duration.
  • Set with class: ns3::TimeValue
  • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
  • Initial value: +2.5e+08ns
  • Flags: construct write read
• DlRlcOutputFilename: Name of the file where the downlink results will be saved.
  • Set with class: ns3::StringValue
  • Underlying type:
  • Initial value: NrDlRlcStatsE2E.txt
  • Flags: construct write read
• UlRlcOutputFilename: Name of the file where the uplink results will be saved.
  • Set with class: ns3::StringValue
  • Underlying type:
  • Initial value: NrUlRlcStatsE2E.txt
  • Flags: construct write read
• DlPdcpOutputFilename: Name of the file where the downlink results will be saved.
  • Set with class: ns3::StringValue
  • Underlying type:
  • Initial value: NrDlPdcpStatsE2E.txt
  • Flags: construct write read
• UlPdcpOutputFilename: Name of the file where the uplink results will be saved.
  • Set with class: ns3::StringValue
  • Underlying type:
  • Initial value: NrUlPdcpStatsE2E.txt
  • Flags: construct write read

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

Definition at line 55 of file nr-bearer-stats-calculator.h.

Constructor & Destructor Documentation

NrBearerStatsCalculator() [1/2]

ns3::NrBearerStatsCalculator::NrBearerStatsCalculator

(

)

Class constructor

Definition at line 22 of file nr-bearer-stats-calculator.cc.

NrBearerStatsCalculator() [2/2]

ns3::NrBearerStatsCalculator::NrBearerStatsCalculator

(

std::string

protocolType

)

Class constructor

Definition at line 30 of file nr-bearer-stats-calculator.cc.

~NrBearerStatsCalculator()

ns3::NrBearerStatsCalculator::~NrBearerStatsCalculator ( )

override

Class destructor

Definition at line 38 of file nr-bearer-stats-calculator.cc.

Member Function Documentation

DlRxPdu()

void ns3::NrBearerStatsCalculator::DlRxPdu ( uint16_t  cellId, uint64_t  imsi, uint16_t  rnti, uint8_t  lcid, uint32_t  packetSize, uint64_t  delay  )

overridevirtual

Notifies the stats calculator that an downlink reception has occurred.

Parameters

cellId	CellId of the attached Enb
imsi	IMSI of the UE who received the PDU
rnti	C-RNTI of the UE who received the PDU
lcid	LCID through which the PDU has been transmitted
packetSize	size of the PDU in bytes
delay	RLC to RLC delay in nanoseconds

Implements ns3::NrBearerStatsBase.

Definition at line 194 of file nr-bearer-stats-calculator.cc.

DlTxPdu()

void ns3::NrBearerStatsCalculator::DlTxPdu ( uint16_t  cellId, uint64_t  imsi, uint16_t  rnti, uint8_t  lcid, uint32_t  packetSize  )

overridevirtual

Notifies the stats calculator that an downlink transmission has occurred.

Parameters

cellId	CellId of the attached Enb
imsi	IMSI of the UE who is receiving the PDU
rnti	C-RNTI of the UE who is receiving the PDU
lcid	LCID through which the PDU has been transmitted
packetSize	size of the PDU in bytes

Implements ns3::NrBearerStatsBase.

Definition at line 143 of file nr-bearer-stats-calculator.cc.

DoDispose()

void ns3::NrBearerStatsCalculator::DoDispose ( )

override

Definition at line 87 of file nr-bearer-stats-calculator.cc.

GetDlCellId()

uint32_t ns3::NrBearerStatsCalculator::GetDlCellId	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the attached Enb cellId.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

Enb cellId

Definition at line 545 of file nr-bearer-stats-calculator.cc.

GetDlDelay()

double ns3::NrBearerStatsCalculator::GetDlDelay	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the downlink RLC to RLC delay

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

RLC to RLC delay in seconds

Definition at line 553 of file nr-bearer-stats-calculator.cc.

GetDlDelayStats()

std::vector< double > ns3::NrBearerStatsCalculator::GetDlDelayStats	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the downlink RLC to RLC statistics: average, min, max and standard deviation.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

RLC to RLC delay statistics average, min, max and standard deviation in seconds

Definition at line 567 of file nr-bearer-stats-calculator.cc.

GetDlOutputFilename()

std::string ns3::NrBearerStatsCalculator::GetDlOutputFilename

(

)

return DL output file name

Definition at line 624 of file nr-bearer-stats-calculator.cc.

GetDlPduSizeStats()

std::vector< double > ns3::NrBearerStatsCalculator::GetDlPduSizeStats	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the downlink PDU size statistics: average, min, max and standard deviation.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

PDU size statistics average, min, max and standard deviation in seconds

Definition at line 589 of file nr-bearer-stats-calculator.cc.

GetDlRxData()

uint64_t ns3::NrBearerStatsCalculator::GetDlRxData	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of received downlink data bytes.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of received data bytes

Definition at line 529 of file nr-bearer-stats-calculator.cc.

GetDlRxPackets()

uint32_t ns3::NrBearerStatsCalculator::GetDlRxPackets	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of received downlink data bytes.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of received data bytes

Definition at line 513 of file nr-bearer-stats-calculator.cc.

GetDlTxData()

uint64_t ns3::NrBearerStatsCalculator::GetDlTxData	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of transmitted downlink data bytes.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of transmitted data bytes

Definition at line 521 of file nr-bearer-stats-calculator.cc.

GetDlTxPackets()

uint32_t ns3::NrBearerStatsCalculator::GetDlTxPackets	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of transmitted downlink data bytes.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of transmitted data bytes

Definition at line 505 of file nr-bearer-stats-calculator.cc.

GetEpoch()

Time ns3::NrBearerStatsCalculator::GetEpoch

(

)

const

Returns

the epoch duration

Definition at line 117 of file nr-bearer-stats-calculator.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

GetStartTime()

Time ns3::NrBearerStatsCalculator::GetStartTime

(

)

const

Returns

the value of the StartTime attribute

Definition at line 104 of file nr-bearer-stats-calculator.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

GetTypeId()

TypeId ns3::NrBearerStatsCalculator::GetTypeId ( )

static

Register this type.

Returns

The object TypeId.

Definition at line 44 of file nr-bearer-stats-calculator.cc.

References GetEpoch(), GetStartTime(), SetEpoch(), and SetStartTime().

Here is the call graph for this function:

GetUlCellId()

uint32_t ns3::NrBearerStatsCalculator::GetUlCellId	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the attached Enb cellId.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

Enb cellId

Definition at line 537 of file nr-bearer-stats-calculator.cc.

GetUlDelay()

double ns3::NrBearerStatsCalculator::GetUlDelay	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the uplink RLC to RLC delay

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

RLC to RLC delay in seconds

Definition at line 447 of file nr-bearer-stats-calculator.cc.

GetUlDelayStats()

std::vector< double > ns3::NrBearerStatsCalculator::GetUlDelayStats	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the uplink RLC to RLC statistics: average, min, max and standard deviation.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

RLC to RLC delay statistics average, min, max and standard deviation in seconds

Definition at line 461 of file nr-bearer-stats-calculator.cc.

GetUlOutputFilename()

std::string ns3::NrBearerStatsCalculator::GetUlOutputFilename

(

)

Returns

UL output file name

Definition at line 611 of file nr-bearer-stats-calculator.cc.

GetUlPduSizeStats()

std::vector< double > ns3::NrBearerStatsCalculator::GetUlPduSizeStats	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the uplink PDU size statistics: average, min, max and standard deviation.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

PDU size statistics average, min, max and standard deviation in seconds

Definition at line 483 of file nr-bearer-stats-calculator.cc.

GetUlRxData()

uint64_t ns3::NrBearerStatsCalculator::GetUlRxData	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of received uplink data bytes.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of received data bytes

Definition at line 439 of file nr-bearer-stats-calculator.cc.

GetUlRxPackets()

uint32_t ns3::NrBearerStatsCalculator::GetUlRxPackets	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of received uplink packets.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of received uplink packets

Definition at line 423 of file nr-bearer-stats-calculator.cc.

GetUlTxData()

uint64_t ns3::NrBearerStatsCalculator::GetUlTxData	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of transmitted uplink data bytes.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of transmitted data bytes

Definition at line 431 of file nr-bearer-stats-calculator.cc.

GetUlTxPackets()

uint32_t ns3::NrBearerStatsCalculator::GetUlTxPackets	(	uint64_t	imsi,
		uint8_t	lcid
	)

Gets the number of transmitted uplink packets.

Parameters

imsi	IMSI of the UE
lcid	LCID

Returns

number of transmitted uplink packets

Definition at line 415 of file nr-bearer-stats-calculator.cc.

SetEpoch()

void ns3::NrBearerStatsCalculator::SetEpoch

(

Time

e

)

Parameters

e	the epoch duration

Definition at line 110 of file nr-bearer-stats-calculator.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

SetStartTime()

void ns3::NrBearerStatsCalculator::SetStartTime

(

Time

t

)

Parameters

t	the value of the StartTime attribute

Definition at line 97 of file nr-bearer-stats-calculator.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

UlRxPdu()

void ns3::NrBearerStatsCalculator::UlRxPdu ( uint16_t  cellId, uint64_t  imsi, uint16_t  rnti, uint8_t  lcid, uint32_t  packetSize, uint64_t  delay  )

overridevirtual

Notifies the stats calculator that an uplink reception has occurred.

Parameters

cellId	CellId of the attached Enb
imsi	IMSI of the UE who received the PDU
rnti	C-RNTI of the UE who received the PDU
lcid	LCID through which the PDU has been received
packetSize	size of the PDU in bytes
delay	RLC to RLC delay in nanoseconds

Implements ns3::NrBearerStatsBase.

Definition at line 163 of file nr-bearer-stats-calculator.cc.

UlTxPdu()

void ns3::NrBearerStatsCalculator::UlTxPdu ( uint16_t  cellId, uint64_t  imsi, uint16_t  rnti, uint8_t  lcid, uint32_t  packetSize  )

overridevirtual

Notifies the stats calculator that an uplink transmission has occurred.

Parameters

cellId	CellId of the attached Enb
imsi	IMSI of the UE who transmitted the PDU
rnti	C-RNTI of the UE who transmitted the PDU
lcid	LCID through which the PDU has been transmitted
packetSize	size of the PDU in bytes

Implements ns3::NrBearerStatsBase.

Definition at line 123 of file nr-bearer-stats-calculator.cc.

---

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

• nr-bearer-stats-calculator.h
• nr-bearer-stats-calculator.cc