A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::PhyStatsCalculator Class Reference

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

#include <phy-stats-calculator.h>

+ Inheritance diagram for ns3::PhyStatsCalculator:
+ Collaboration diagram for ns3::PhyStatsCalculator:

Public Member Functions

 PhyStatsCalculator ()
 Constructor. More...
 
virtual ~PhyStatsCalculator ()
 Destructor. More...
 
std::string GetCurrentCellRsrpSinrFilename (void)
 Get the name of the file where the RSRP/SINR statistics will be stored. More...
 
std::string GetInterferenceFilename (void)
 Get the name of the file where the interference statistics will be stored. More...
 
std::string GetUeSinrFilename (void)
 Get the name of the file where the UE SINR statistics will be stored. More...
 
void ReportCurrentCellRsrpSinr (uint16_t cellId, uint64_t imsi, uint16_t rnti, double rsrp, double sinr)
 Notifies the stats calculator that an RSRP and SINR report has occurred. More...
 
void ReportInterference (uint16_t cellId, Ptr< SpectrumValue > interference)
 Notifies the stats calculator that an interference report has occurred. More...
 
void ReportUeSinr (uint16_t cellId, uint64_t imsi, uint16_t rnti, double sinrLinear)
 Notifies the stats calculator that an UE SINR report has occurred. More...
 
void SetCurrentCellRsrpSinrFilename (std::string filename)
 Set the name of the file where the RSRP/SINR statistics will be stored. More...
 
void SetInterferenceFilename (std::string filename)
 Set the name of the file where the interference statistics will be stored. More...
 
void SetUeSinrFilename (std::string filename)
 Set the name of the file where the UE SINR statistics will be stored. 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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
static void ReportCurrentCellRsrpSinrCallback (Ptr< PhyStatsCalculator > phyStats, std::string path, uint16_t cellId, uint16_t rnti, double rsrp, double sinr)
 trace sink More...
 
static void ReportInterference (Ptr< PhyStatsCalculator > phyStats, std::string path, uint16_t cellId, Ptr< SpectrumValue > interference)
 trace sink More...
 
static void ReportUeSinr (Ptr< PhyStatsCalculator > phyStats, std::string path, uint16_t cellId, uint16_t rnti, double sinrLinear)
 trace sink More...
 
- Static Public Member Functions inherited from ns3::LteStatsCalculator
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::string m_interferenceFilename
 
bool m_InterferenceFirstWrite
 
std::string m_RsrpSinrFilename
 
bool m_RsrpSinrFirstWrite
 
std::string m_ueSinrFilename
 
bool m_UeSinrFirstWrite
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 
- Static Protected Member Functions inherited from ns3::LteStatsCalculator
static uint16_t FindCellIdFromEnbMac (std::string path, uint16_t rnti)
 
static uint16_t FindCellIdFromEnbRlcPath (std::string path)
 
static uint64_t FindImsiForEnb (std::string path, uint16_t rnti)
 
static uint64_t FindImsiForUe (std::string path, uint16_t rnti)
 
static uint64_t FindImsiFromEnbMac (std::string path, uint16_t rnti)
 
static uint64_t FindImsiFromEnbRlcPath (std::string path)
 
static uint64_t FindImsiFromLteNetDevice (std::string path)
 
static uint64_t FindImsiFromUePhy (std::string path)
 

Detailed Description

Takes care of storing the information generated at PHY layer.

Doxygen introspection did not find any typical Config paths.

Metrics saved are:

  • RSRP and average SINR for DL
    • Timestamp (in seconds)
    • IMSI
    • C-RNTI
    • RSRP
    • SINR
  • UE SINR
    • Timestamp (in seconds)
    • Cell ID of the reported Enb
    • IMSI
    • C-RNTI
    • measured and reported SINR value in linear
  • Interference for UL
    • Cell ID of the reported Enb
    • IMSI of the scheduled UE
    • C-RNTI scheduled
    • Measured interference for each RB


Attributes

  • DlRsrpSinrFilename: Name of the file where the RSRP/SINR statistics will be saved.
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: DlRsrpSinrStats.txt
    • Flags: construct write
  • UlSinrFilename: Name of the file where the UE SINR statistics will be saved.
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: UlSinrStats.txt
    • Flags: construct write
  • UlInterferenceFilename: Name of the file where the interference statistics will be saved.
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: UlInterferenceStats.txt
    • Flags: construct write

No TraceSources are defined for this type.

Definition at line 53 of file phy-stats-calculator.h.

Constructor & Destructor Documentation

ns3::PhyStatsCalculator::PhyStatsCalculator ( )

Constructor.

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

References NS_LOG_FUNCTION.

ns3::PhyStatsCalculator::~PhyStatsCalculator ( )
virtual

Destructor.

Definition at line 43 of file phy-stats-calculator.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

std::string ns3::PhyStatsCalculator::GetCurrentCellRsrpSinrFilename ( void  )

Get the name of the file where the RSRP/SINR statistics will be stored.

Returns
the name of the file where the RSRP/SINR statistics will be stored

Definition at line 80 of file phy-stats-calculator.cc.

References m_RsrpSinrFilename.

Referenced by ReportCurrentCellRsrpSinr().

+ Here is the caller graph for this function:

std::string ns3::PhyStatsCalculator::GetInterferenceFilename ( void  )

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

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

Definition at line 104 of file phy-stats-calculator.cc.

References m_interferenceFilename.

Referenced by ReportInterference().

+ Here is the caller graph for this function:

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

Definition at line 49 of file phy-stats-calculator.cc.

References SetCurrentCellRsrpSinrFilename(), SetInterferenceFilename(), ns3::TypeId::SetParent(), and SetUeSinrFilename().

+ Here is the call graph for this function:

std::string ns3::PhyStatsCalculator::GetUeSinrFilename ( void  )

Get the name of the file where the UE SINR statistics will be stored.

Returns
the name of the file where the UE SINR statistics will be stored

Definition at line 92 of file phy-stats-calculator.cc.

References m_ueSinrFilename.

Referenced by ReportUeSinr().

+ Here is the caller graph for this function:

void ns3::PhyStatsCalculator::ReportCurrentCellRsrpSinr ( uint16_t  cellId,
uint64_t  imsi,
uint16_t  rnti,
double  rsrp,
double  sinr 
)

Notifies the stats calculator that an RSRP and SINR report has occurred.

Parameters
imsiIMSI of the scheduled UE
rntiC-RNTI scheduled
rsrpReference Signal Received Power
sinrSINR averaged among RBs

Definition at line 112 of file phy-stats-calculator.cc.

References GetCurrentCellRsrpSinrFilename(), ns3::Time::GetNanoSeconds(), m_RsrpSinrFirstWrite, ns3::Simulator::Now(), NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

void ns3::PhyStatsCalculator::ReportCurrentCellRsrpSinrCallback ( Ptr< PhyStatsCalculator phyStats,
std::string  path,
uint16_t  cellId,
uint16_t  rnti,
double  rsrp,
double  sinr 
)
static

trace sink

Parameters
phyStats
path
cellId
rnti
rsrp
sinr

Definition at line 224 of file phy-stats-calculator.cc.

References ns3::LteStatsCalculator::FindImsiFromUePhy(), and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::PhyStatsCalculator::ReportInterference ( uint16_t  cellId,
Ptr< SpectrumValue interference 
)

Notifies the stats calculator that an interference report has occurred.

Parameters
cellIdCell ID of the reported Enb
interferenceMeasured interference for each RB

Definition at line 188 of file phy-stats-calculator.cc.

References GetInterferenceFilename(), ns3::Time::GetNanoSeconds(), m_InterferenceFirstWrite, ns3::Simulator::Now(), NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::PhyStatsCalculator::ReportInterference ( Ptr< PhyStatsCalculator phyStats,
std::string  path,
uint16_t  cellId,
Ptr< SpectrumValue interference 
)
static

trace sink

Parameters
phyStats
path
cellId
interference

Definition at line 269 of file phy-stats-calculator.cc.

References NS_LOG_FUNCTION.

void ns3::PhyStatsCalculator::ReportUeSinr ( uint16_t  cellId,
uint64_t  imsi,
uint16_t  rnti,
double  sinrLinear 
)

Notifies the stats calculator that an UE SINR report has occurred.

Parameters
cellIdCell ID of the reported Enb
imsiIMSI of the scheduled UE
rntiC-RNTI scheduled
sinrLinearmeasured and reported SINR value in linear

Definition at line 151 of file phy-stats-calculator.cc.

References ns3::Time::GetNanoSeconds(), GetUeSinrFilename(), m_UeSinrFirstWrite, ns3::Simulator::Now(), NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::PhyStatsCalculator::ReportUeSinr ( Ptr< PhyStatsCalculator phyStats,
std::string  path,
uint16_t  cellId,
uint16_t  rnti,
double  sinrLinear 
)
static

trace sink

Parameters
phyStats
path
cellId
rnti
sinrLinear

Definition at line 245 of file phy-stats-calculator.cc.

References ns3::LteStatsCalculator::FindImsiFromEnbMac(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::PhyStatsCalculator::SetCurrentCellRsrpSinrFilename ( std::string  filename)

Set the name of the file where the RSRP/SINR statistics will be stored.

Parameters
filenamestring with the name of the file

Definition at line 74 of file phy-stats-calculator.cc.

References m_RsrpSinrFilename.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::PhyStatsCalculator::SetInterferenceFilename ( std::string  filename)

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

Parameters
filenamestring with the name of the file

Definition at line 98 of file phy-stats-calculator.cc.

References m_interferenceFilename.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::PhyStatsCalculator::SetUeSinrFilename ( std::string  filename)

Set the name of the file where the UE SINR statistics will be stored.

Parameters
filenamestring with the name of the file

Definition at line 86 of file phy-stats-calculator.cc.

References m_ueSinrFilename.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

std::string ns3::PhyStatsCalculator::m_interferenceFilename
private

Definition at line 177 of file phy-stats-calculator.h.

Referenced by GetInterferenceFilename(), and SetInterferenceFilename().

bool ns3::PhyStatsCalculator::m_InterferenceFirstWrite
private

Definition at line 173 of file phy-stats-calculator.h.

Referenced by ReportInterference().

std::string ns3::PhyStatsCalculator::m_RsrpSinrFilename
private
bool ns3::PhyStatsCalculator::m_RsrpSinrFirstWrite
private

Definition at line 171 of file phy-stats-calculator.h.

Referenced by ReportCurrentCellRsrpSinr().

std::string ns3::PhyStatsCalculator::m_ueSinrFilename
private

Definition at line 176 of file phy-stats-calculator.h.

Referenced by GetUeSinrFilename(), and SetUeSinrFilename().

bool ns3::PhyStatsCalculator::m_UeSinrFirstWrite
private

Definition at line 172 of file phy-stats-calculator.h.

Referenced by ReportUeSinr().


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