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

Base class for ***StatsCalculator classes. More...

#include "lte-stats-calculator.h"

+ Inheritance diagram for ns3::LteStatsCalculator:
+ Collaboration diagram for ns3::LteStatsCalculator:

Public Member Functions

 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 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...
 

Static Protected Member Functions

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...
 

Private Attributes

std::string m_dlOutputFilename
 Name of the file where the downlink results will be saved. More...
 
std::map< std::string, uint16_t > m_pathCellIdMap
 List of CellId by path in the attribute system. More...
 
std::map< std::string, uint64_t > m_pathImsiMap
 List of IMSI by path in the attribute system. More...
 
std::string m_ulOutputFilename
 Name of the file where the uplink results will be saved. 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...
 

Detailed Description

Base class for ***StatsCalculator classes.

Introspection did not find any typical Config paths.

Provides basic functionality to parse and store IMSI and CellId. Also stores names of output files.


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

Definition at line 38 of file lte-stats-calculator.h.

Constructor & Destructor Documentation

◆ LteStatsCalculator()

ns3::LteStatsCalculator::LteStatsCalculator ( )

Constructor.

Definition at line 36 of file lte-stats-calculator.cc.

◆ ~LteStatsCalculator()

ns3::LteStatsCalculator::~LteStatsCalculator ( )
virtual

Destructor.

Definition at line 44 of file lte-stats-calculator.cc.

Member Function Documentation

◆ ExistsCellIdPath()

bool ns3::LteStatsCalculator::ExistsCellIdPath ( std::string  path)

Checks if there is an already stored cell id for the given path.

Parameters
pathPath in the attribute system to check
Returns
true if the path exists, false otherwise

Definition at line 114 of file lte-stats-calculator.cc.

References m_pathCellIdMap, and trim-trailing-whitespace::path.

◆ ExistsImsiPath()

bool ns3::LteStatsCalculator::ExistsImsiPath ( std::string  path)

Checks if there is an already stored IMSI for the given path.

Parameters
pathPath in the attribute system to check
Returns
true if the path exists, false otherwise

Definition at line 88 of file lte-stats-calculator.cc.

References m_pathImsiMap, and trim-trailing-whitespace::path.

◆ FindCellIdFromEnbMac()

uint16_t ns3::LteStatsCalculator::FindCellIdFromEnbMac ( std::string  path,
uint16_t  rnti 
)
staticprotected

Retrieves CellId from Enb MAC path in the attribute system.

Parameters
pathPath in the attribute system to get
rntiRNTI of UE for which CellId is needed
Returns
the CellId associated with the given path and RNTI

Definition at line 251 of file lte-stats-calculator.cc.

References FindCellIdFromEnbRlcPath(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

+ Here is the call graph for this function:

◆ FindCellIdFromEnbRlcPath()

uint16_t ns3::LteStatsCalculator::FindCellIdFromEnbRlcPath ( std::string  path)
staticprotected

Retrieves CellId from Enb RLC path in the attribute system.

Parameters
pathPath in the attribute system to get
Returns
the CellId associated with the given path

Definition at line 213 of file lte-stats-calculator.cc.

References ns3::Config::MatchContainer::Get(), ns3::LteEnbNetDevice::GetCellId(), ns3::Config::MatchContainer::GetN(), ns3::Object::GetObject(), ns3::Config::LookupMatches(), NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

Referenced by ns3::MacStatsCalculator::DlSchedulingCallback(), FindCellIdFromEnbMac(), and ns3::MacStatsCalculator::UlSchedulingCallback().

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

◆ FindImsiForEnb()

uint64_t ns3::LteStatsCalculator::FindImsiForEnb ( std::string  path,
uint16_t  rnti 
)
staticprotected

Retrieves IMSI from path for Enb in the attribute system.

Parameters
pathPath in the attribute system to get
rntiRNTI of UE for which IMSI is needed
Returns
the IMSI associated with the given path and RNTI

Definition at line 266 of file lte-stats-calculator.cc.

References FindImsiFromEnbRlcPath(), FindImsiFromLteNetDevice(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

+ Here is the call graph for this function:

◆ FindImsiForUe()

uint64_t ns3::LteStatsCalculator::FindImsiForUe ( std::string  path,
uint16_t  rnti 
)
staticprotected

Retrieves IMSI from path for Ue in the attribute system.

Parameters
pathPath in the attribute system to get
rntiRNTI of UE for which IMSI is needed
Returns
the IMSI associated with the given path and RNTI

Definition at line 291 of file lte-stats-calculator.cc.

References FindImsiFromEnbRlcPath(), FindImsiFromLteNetDevice(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

+ Here is the call graph for this function:

◆ FindImsiFromEnbMac()

uint64_t ns3::LteStatsCalculator::FindImsiFromEnbMac ( std::string  path,
uint16_t  rnti 
)
staticprotected

Retrieves IMSI from Enb MAC path in the attribute system.

Parameters
pathPath in the attribute system to get
rntiRNTI of UE for which IMSI is needed
Returns
the IMSI associated with the given path and RNTI

Definition at line 236 of file lte-stats-calculator.cc.

References FindImsiFromEnbRlcPath(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

Referenced by ns3::PhyStatsCalculator::ReportUeSinr().

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

◆ FindImsiFromEnbRlcPath()

uint64_t ns3::LteStatsCalculator::FindImsiFromEnbRlcPath ( std::string  path)
staticprotected

Retrieves IMSI from Enb RLC path in the attribute system.

Parameters
pathPath in the attribute system to get
Returns
the IMSI associated with the given path

Definition at line 141 of file lte-stats-calculator.cc.

References ns3::Config::MatchContainer::Get(), ns3::UeManager::GetImsi(), ns3::Config::MatchContainer::GetN(), ns3::Object::GetObject(), ns3::Config::LookupMatches(), NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

Referenced by ns3::PhyTxStatsCalculator::DlPhyTransmissionCallback(), ns3::MacStatsCalculator::DlSchedulingCallback(), FindImsiForEnb(), FindImsiForUe(), FindImsiFromEnbMac(), ns3::PhyRxStatsCalculator::UlPhyReceptionCallback(), and ns3::MacStatsCalculator::UlSchedulingCallback().

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

◆ FindImsiFromLteNetDevice()

uint64_t ns3::LteStatsCalculator::FindImsiFromLteNetDevice ( std::string  path)
staticprotected

Retrieves IMSI from LteNetDevice path in the attribute system.

Parameters
pathPath in the attribute system to get
Returns
the IMSI associated with the given path

Definition at line 190 of file lte-stats-calculator.cc.

References ns3::Config::MatchContainer::Get(), ns3::LteUeNetDevice::GetImsi(), ns3::Config::MatchContainer::GetN(), ns3::Object::GetObject(), ns3::Config::LookupMatches(), NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, and trim-trailing-whitespace::path.

Referenced by ns3::PhyRxStatsCalculator::DlPhyReceptionCallback(), FindImsiForEnb(), FindImsiForUe(), ns3::PhyStatsCalculator::ReportCurrentCellRsrpSinrCallback(), and ns3::PhyTxStatsCalculator::UlPhyTransmissionCallback().

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

◆ FindImsiFromUePhy()

uint64_t ns3::LteStatsCalculator::FindImsiFromUePhy ( std::string  path)
staticprotected

Retrieves IMSI from Ue PHY path in the attribute system.

Parameters
pathPath in the attribute system to get
Returns
the IMSI associated with the given path

Definition at line 165 of file lte-stats-calculator.cc.

References ns3::Config::MatchContainer::Get(), ns3::Config::MatchContainer::GetN(), ns3::Object::GetObject(), ns3::Config::LookupMatches(), NS_FATAL_ERROR, NS_LOG_FUNCTION, and trim-trailing-whitespace::path.

+ Here is the call graph for this function:

◆ GetCellIdPath()

uint16_t ns3::LteStatsCalculator::GetCellIdPath ( std::string  path)

Retrieves the cell id information for the given path.

Parameters
pathPath in the attribute system to get
Returns
the cell ID associated with the given path

Definition at line 134 of file lte-stats-calculator.cc.

References m_pathCellIdMap, and trim-trailing-whitespace::path.

◆ GetDlOutputFilename()

std::string ns3::LteStatsCalculator::GetDlOutputFilename ( void  )

Get the name of the file where the downlink statistics will be stored.

Returns
the name of the file where the downlink statistics will be stored

Definition at line 81 of file lte-stats-calculator.cc.

References m_dlOutputFilename.

Referenced by ns3::PhyTxStatsCalculator::DlPhyTransmission(), ns3::MacStatsCalculator::GetDlOutputFilename(), ns3::RadioBearerStatsCalculator::GetDlOutputFilename(), ns3::PhyRxStatsCalculator::GetDlRxOutputFilename(), and ns3::PhyTxStatsCalculator::GetDlTxOutputFilename().

+ Here is the caller graph for this function:

◆ GetImsiPath()

uint64_t ns3::LteStatsCalculator::GetImsiPath ( std::string  path)

Retrieves the imsi information for the given path.

Parameters
pathPath in the attribute system to get
Returns
the IMSI associated with the given path

Definition at line 108 of file lte-stats-calculator.cc.

References m_pathImsiMap, and trim-trailing-whitespace::path.

◆ GetTypeId()

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

Register this type.

Returns
The object TypeId.

Definition at line 51 of file lte-stats-calculator.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUlOutputFilename()

std::string ns3::LteStatsCalculator::GetUlOutputFilename ( void  )

Get the name of the file where the uplink statistics will be stored.

Returns
the name of the file where the uplink statistics will be stored

Definition at line 69 of file lte-stats-calculator.cc.

References m_ulOutputFilename.

Referenced by ns3::MacStatsCalculator::GetUlOutputFilename(), ns3::RadioBearerStatsCalculator::GetUlOutputFilename(), ns3::PhyRxStatsCalculator::GetUlRxOutputFilename(), and ns3::PhyTxStatsCalculator::GetUlTxOutputFilename().

+ Here is the caller graph for this function:

◆ SetCellIdPath()

void ns3::LteStatsCalculator::SetCellIdPath ( std::string  path,
uint16_t  cellId 
)

Stores the (path, cellId) pairs in a map.

Parameters
pathPath in the attribute system to store
cellIdcell id value to store

Definition at line 127 of file lte-stats-calculator.cc.

References m_pathCellIdMap, NS_LOG_FUNCTION, and trim-trailing-whitespace::path.

◆ SetDlOutputFilename()

void ns3::LteStatsCalculator::SetDlOutputFilename ( std::string  outputFilename)

Set the name of the file where the downlink statistics will be stored.

Parameters
outputFilenamestring with the name of the file

Definition at line 75 of file lte-stats-calculator.cc.

References m_dlOutputFilename.

Referenced by ns3::RadioBearerStatsCalculator::GetTypeId(), ns3::MacStatsCalculator::SetDlOutputFilename(), ns3::PhyRxStatsCalculator::SetDlRxOutputFilename(), and ns3::PhyTxStatsCalculator::SetDlTxOutputFilename().

+ Here is the caller graph for this function:

◆ SetImsiPath()

void ns3::LteStatsCalculator::SetImsiPath ( std::string  path,
uint64_t  imsi 
)

Stores the (path, imsi) pairs in a map.

Parameters
pathPath in the attribute system to store
imsiIMSI value to store

Definition at line 101 of file lte-stats-calculator.cc.

References m_pathImsiMap, NS_LOG_FUNCTION, and trim-trailing-whitespace::path.

◆ SetUlOutputFilename()

void ns3::LteStatsCalculator::SetUlOutputFilename ( std::string  outputFilename)

Set the name of the file where the uplink statistics will be stored.

Parameters
outputFilenamestring with the name of the file

Definition at line 63 of file lte-stats-calculator.cc.

References m_ulOutputFilename.

Referenced by ns3::RadioBearerStatsCalculator::GetTypeId(), ns3::MacStatsCalculator::SetUlOutputFilename(), ns3::PhyRxStatsCalculator::SetUlRxOutputFilename(), and ns3::PhyTxStatsCalculator::SetUlTxOutputFilename().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_dlOutputFilename

std::string ns3::LteStatsCalculator::m_dlOutputFilename
private

Name of the file where the downlink results will be saved.

Definition at line 201 of file lte-stats-calculator.h.

Referenced by GetDlOutputFilename(), and SetDlOutputFilename().

◆ m_pathCellIdMap

std::map<std::string, uint16_t> ns3::LteStatsCalculator::m_pathCellIdMap
private

List of CellId by path in the attribute system.

Definition at line 196 of file lte-stats-calculator.h.

Referenced by ExistsCellIdPath(), GetCellIdPath(), and SetCellIdPath().

◆ m_pathImsiMap

std::map<std::string, uint64_t> ns3::LteStatsCalculator::m_pathImsiMap
private

List of IMSI by path in the attribute system.

Definition at line 191 of file lte-stats-calculator.h.

Referenced by ExistsImsiPath(), GetImsiPath(), and SetImsiPath().

◆ m_ulOutputFilename

std::string ns3::LteStatsCalculator::m_ulOutputFilename
private

Name of the file where the uplink results will be saved.

Definition at line 206 of file lte-stats-calculator.h.

Referenced by GetUlOutputFilename(), and SetUlOutputFilename().


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