A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::PhyStatsCalculator Class Reference

#include <phy-stats-calculator.h>

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

Public Member Functions

 PhyStatsCalculator ()
virtual ~PhyStatsCalculator ()
std::string GetCurrentCellRsrpSinrFilename (void)
std::string GetInterferenceFilename (void)
std::string GetUeSinrFilename (void)
void ReportCurrentCellRsrpSinr (uint16_t cellId, uint64_t imsi, uint16_t rnti, double rsrp, double sinr)
void ReportInterference (uint16_t cellId, Ptr< SpectrumValue > interference)
void ReportUeSinr (uint16_t cellId, uint64_t imsi, uint16_t rnti, double sinrLinear)
void SetCurrentCellRsrpSinrFilename (std::string filename)
void SetInterferenceFilename (std::string filename)
void SetUeSinrFilename (std::string filename)
- Public Member Functions inherited from ns3::LteStatsCalculator
 LteStatsCalculator ()
virtual ~LteStatsCalculator ()
bool ExistsCellIdPath (std::string path)
bool ExistsImsiPath (std::string path)
uint16_t GetCellIdPath (std::string path)
std::string GetDlOutputFilename (void)
uint64_t GetImsiPath (std::string path)
std::string GetUlOutputFilename (void)
void SetCellIdPath (std::string path, uint16_t cellId)
void SetDlOutputFilename (std::string outputFilename)
void SetImsiPath (std::string path, uint64_t imsi)
void SetUlOutputFilename (std::string outputFilename)
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
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)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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)

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)
virtual void DoInitialize (void)
virtual void NotifyNewAggregate (void)

Detailed Description

Takes care of storing the information generated at PHY layer. 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

Doxygen introspection did not find any typical Config paths.

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 32 of file phy-stats-calculator.cc.

References NS_LOG_FUNCTION.

ns3::PhyStatsCalculator::~PhyStatsCalculator ( )
virtual

Destructor

Definition at line 41 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.

Definition at line 78 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.

Definition at line 102 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

Inherited from ns3::Object

Reimplemented from ns3::LteStatsCalculator.

Definition at line 47 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.

Definition at line 90 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 110 of file phy-stats-calculator.cc.

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

Referenced by ns3::ReportCurrentCellRsrpSinrCallback().

+ 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
imsiIMSI of the scheduled UE
rntiC-RNTI scheduled
cellIdCell ID of the reported Enb
interferenceMeasured interference for each RB

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

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

Referenced by ns3::ReportInterference().

+ Here is the call graph for this function:

+ Here is the caller graph for this 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 149 of file phy-stats-calculator.cc.

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

Referenced by ns3::ReportUeSinr().

+ Here is the call graph for this function:

+ Here is the caller 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 72 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 96 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 84 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 140 of file phy-stats-calculator.h.

Referenced by GetInterferenceFilename(), and SetInterferenceFilename().

bool ns3::PhyStatsCalculator::m_InterferenceFirstWrite
private

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

Referenced by ReportInterference().

std::string ns3::PhyStatsCalculator::m_RsrpSinrFilename
private

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

Referenced by GetCurrentCellRsrpSinrFilename(), and SetCurrentCellRsrpSinrFilename().

bool ns3::PhyStatsCalculator::m_RsrpSinrFirstWrite
private

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

Referenced by ReportCurrentCellRsrpSinr().

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

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

Referenced by GetUeSinrFilename(), and SetUeSinrFilename().

bool ns3::PhyStatsCalculator::m_UeSinrFirstWrite
private

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

Referenced by ReportUeSinr().

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