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::PhyRxStatsCalculator Class Reference

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

#include <phy-rx-stats-calculator.h>

+ Inheritance diagram for ns3::PhyRxStatsCalculator:
+ Collaboration diagram for ns3::PhyRxStatsCalculator:

Public Member Functions

 PhyRxStatsCalculator ()
 Constructor. More...
 
virtual ~PhyRxStatsCalculator ()
 Destructor. More...
 
void DlPhyReception (PhyReceptionStatParameters params)
 Notifies the stats calculator that an downlink reception has occurred. More...
 
std::string GetDlRxOutputFilename (void)
 Get the name of the file where the DL RX PHY statistics will be stored. More...
 
std::string GetUlRxOutputFilename (void)
 Get the name of the file where the UL RX PHY statistics will be stored. More...
 
void SetDlRxOutputFilename (std::string outputFilename)
 Set the name of the file where the DL RX PHY statistics will be stored. More...
 
void SetUlRxOutputFilename (std::string outputFilename)
 Set the name of the file where the UL Rx PHY statistics will be stored. More...
 
void UlPhyReception (PhyReceptionStatParameters params)
 Notifies the stats calculator that an uplink reception 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 ()
 
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...
 
SimpleRefCount & operator= (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 void DlPhyReceptionCallback (Ptr< PhyRxStatsCalculator > phyRxStats, std::string path, PhyReceptionStatParameters params)
 trace sink More...
 
static TypeId GetTypeId (void)
 
static void UlPhyReceptionCallback (Ptr< PhyRxStatsCalculator > phyRxStats, std::string path, PhyReceptionStatParameters params)
 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

bool m_dlRxFirstWrite
 
bool m_ulRxFirstWrite
 

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

Doxygen 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

  • DlRxOutputFilename: Name of the file where the downlink results will be saved.
    • Set with class: StringValue
    • Underlying type:
    • Initial value: DlRxPhyStats.txt
    • Flags: construct write
  • UlRxOutputFilename: Name of the file where the uplink results will be saved.
    • Set with class: StringValue
    • Underlying type:
    • Initial value: UlRxPhyStats.txt
    • Flags: construct write

No TraceSources are defined for this type.

Definition at line 48 of file phy-rx-stats-calculator.h.

Constructor & Destructor Documentation

ns3::PhyRxStatsCalculator::PhyRxStatsCalculator ( )

Constructor.

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

References NS_LOG_FUNCTION.

ns3::PhyRxStatsCalculator::~PhyRxStatsCalculator ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::PhyRxStatsCalculator::DlPhyReception ( PhyReceptionStatParameters  params)

Notifies the stats calculator that an downlink reception has occurred.

Parameters
paramsTrace information regarding PHY reception stats

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

References GetDlRxOutputFilename(), ns3::PhyReceptionStatParameters::m_cellId, ns3::PhyReceptionStatParameters::m_correctness, m_dlRxFirstWrite, ns3::PhyReceptionStatParameters::m_imsi, ns3::PhyReceptionStatParameters::m_layer, ns3::PhyReceptionStatParameters::m_mcs, ns3::PhyReceptionStatParameters::m_ndi, ns3::PhyReceptionStatParameters::m_rnti, ns3::PhyReceptionStatParameters::m_rv, ns3::PhyReceptionStatParameters::m_size, ns3::PhyReceptionStatParameters::m_timestamp, ns3::PhyReceptionStatParameters::m_txMode, NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

void ns3::PhyRxStatsCalculator::DlPhyReceptionCallback ( Ptr< PhyRxStatsCalculator >  phyRxStats,
std::string  path,
PhyReceptionStatParameters  params 
)
static

trace sink

Parameters
phyRxStats
path
params

Definition at line 179 of file phy-rx-stats-calculator.cc.

References ns3::LteStatsCalculator::FindImsiForUe(), ns3::PhyReceptionStatParameters::m_imsi, ns3::PhyReceptionStatParameters::m_rnti, and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::PhyRxStatsCalculator::GetDlRxOutputFilename ( void  )

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

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

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

References ns3::LteStatsCalculator::GetDlOutputFilename().

Referenced by DlPhyReception().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 48 of file phy-rx-stats-calculator.cc.

References SetDlRxOutputFilename(), ns3::TypeId::SetParent(), and SetUlRxOutputFilename().

+ Here is the call graph for this function:

std::string ns3::PhyRxStatsCalculator::GetUlRxOutputFilename ( 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 74 of file phy-rx-stats-calculator.cc.

References ns3::LteStatsCalculator::GetUlOutputFilename().

Referenced by UlPhyReception().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::PhyRxStatsCalculator::SetDlRxOutputFilename ( std::string  outputFilename)

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

Parameters
outputFilenamestring with the name of the file

Definition at line 80 of file phy-rx-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:

void ns3::PhyRxStatsCalculator::SetUlRxOutputFilename ( std::string  outputFilename)

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

Parameters
outputFilenamestring with the name of the file

Definition at line 68 of file phy-rx-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:

void ns3::PhyRxStatsCalculator::UlPhyReception ( PhyReceptionStatParameters  params)

Notifies the stats calculator that an uplink reception has occurred.

Parameters
paramsTrace information regarding PHY reception stats

Definition at line 136 of file phy-rx-stats-calculator.cc.

References GetUlRxOutputFilename(), ns3::PhyReceptionStatParameters::m_cellId, ns3::PhyReceptionStatParameters::m_correctness, ns3::PhyReceptionStatParameters::m_imsi, ns3::PhyReceptionStatParameters::m_layer, ns3::PhyReceptionStatParameters::m_mcs, ns3::PhyReceptionStatParameters::m_ndi, ns3::PhyReceptionStatParameters::m_rnti, ns3::PhyReceptionStatParameters::m_rv, ns3::PhyReceptionStatParameters::m_size, ns3::PhyReceptionStatParameters::m_timestamp, m_ulRxFirstWrite, NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

void ns3::PhyRxStatsCalculator::UlPhyReceptionCallback ( Ptr< PhyRxStatsCalculator >  phyRxStats,
std::string  path,
PhyReceptionStatParameters  params 
)
static

trace sink

Parameters
phyRxStats
path
params

Definition at line 201 of file phy-rx-stats-calculator.cc.

References ns3::LteStatsCalculator::FindImsiForEnb(), ns3::PhyReceptionStatParameters::m_imsi, ns3::PhyReceptionStatParameters::m_rnti, and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

bool ns3::PhyRxStatsCalculator::m_dlRxFirstWrite
private

Definition at line 123 of file phy-rx-stats-calculator.h.

Referenced by DlPhyReception().

bool ns3::PhyRxStatsCalculator::m_ulRxFirstWrite
private

Definition at line 124 of file phy-rx-stats-calculator.h.

Referenced by UlPhyReception().

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