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

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

#include <mac-stats-calculator.h>

+ Inheritance diagram for ns3::MacStatsCalculator:
+ Collaboration diagram for ns3::MacStatsCalculator:

Public Member Functions

 MacStatsCalculator ()
 Constructor. More...
 
virtual ~MacStatsCalculator ()
 Destructor. More...
 
void DlScheduling (uint16_t cellId, uint64_t imsi, uint32_t frameNo, uint32_t subframeNo, uint16_t rnti, uint8_t mcsTb1, uint16_t sizeTb1, uint8_t mcsTb2, uint16_t sizeTb2)
 Notifies the stats calculator that an downlink scheduling has occurred. More...
 
std::string GetDlOutputFilename (void)
 Get the name of the file where the downlink statistics will be stored. More...
 
std::string GetUlOutputFilename (void)
 Get the name of the file where the uplink statistics will be stored. More...
 
void SetDlOutputFilename (std::string outputFilename)
 Set the name of the file where the downlink statistics will be stored. More...
 
void SetUlOutputFilename (std::string outputFilename)
 Set the name of the file where the uplink statistics will be stored. More...
 
void UlScheduling (uint16_t cellId, uint64_t imsi, uint32_t frameNo, uint32_t subframeNo, uint16_t rnti, uint8_t mcsTb, uint16_t sizeTb)
 Notifies the stats calculator that an uplink scheduling 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...
 
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 void DlSchedulingCallback (Ptr< MacStatsCalculator > macStats, std::string path, uint32_t frameNo, uint32_t subframeNo, uint16_t rnti, uint8_t mcsTb1, uint16_t sizeTb1, uint8_t mcsTb2, uint16_t sizeTb2)
 Trace sink for the ns3::LteEnbMac::DlScheduling trace source. More...
 
static TypeId GetTypeId (void)
 
static void UlSchedulingCallback (Ptr< MacStatsCalculator > macStats, std::string path, uint32_t frameNo, uint32_t subframeNo, uint16_t rnti, uint8_t mcs, uint16_t size)
 Trace sink for the ns3::LteEnbMac::UlScheduling trace source. 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_dlFirstWrite
 
bool m_ulFirstWrite
 

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

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

  • DlOutputFilename: Name of the file where the downlink results will be saved.
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: DlMacStats.txt
    • Flags: construct write
  • UlOutputFilename: Name of the file where the uplink results will be saved.
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: UlMacStats.txt
    • Flags: construct write

No TraceSources are defined for this type.

Definition at line 43 of file mac-stats-calculator.h.

Constructor & Destructor Documentation

ns3::MacStatsCalculator::MacStatsCalculator ( )

Constructor.

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

References NS_LOG_FUNCTION.

ns3::MacStatsCalculator::~MacStatsCalculator ( )
virtual

Destructor.

Definition at line 42 of file mac-stats-calculator.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::MacStatsCalculator::DlScheduling ( uint16_t  cellId,
uint64_t  imsi,
uint32_t  frameNo,
uint32_t  subframeNo,
uint16_t  rnti,
uint8_t  mcsTb1,
uint16_t  sizeTb1,
uint8_t  mcsTb2,
uint16_t  sizeTb2 
)

Notifies the stats calculator that an downlink scheduling has occurred.

Parameters
cellIdCell ID of the attached Enb
imsiIMSI of the scheduled UE
frameNoFrame number
subframeNoSubframe number
rntiC-RNTI scheduled
mcsTb1MCS for transport block 1
sizeTb1Size of transport block 1
mcsTb2MCS for transport block 2 (0 if not used)
sizeTb2Size of transport block 2 (0 if not used)

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

References GetDlOutputFilename(), ns3::Time::GetNanoSeconds(), m_dlFirstWrite, ns3::Simulator::Now(), NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

void ns3::MacStatsCalculator::DlSchedulingCallback ( Ptr< MacStatsCalculator macStats,
std::string  path,
uint32_t  frameNo,
uint32_t  subframeNo,
uint16_t  rnti,
uint8_t  mcsTb1,
uint16_t  sizeTb1,
uint8_t  mcsTb2,
uint16_t  sizeTb2 
)
static

Trace sink for the ns3::LteEnbMac::DlScheduling trace source.

Parameters
macStats
path
frameNo
subframeNo
rnti
mcsTb1
sizeTb1
mcsTb2
sizeTb2

Definition at line 176 of file mac-stats-calculator.cc.

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::MacStatsCalculator::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 86 of file mac-stats-calculator.cc.

References ns3::LteStatsCalculator::GetDlOutputFilename().

Referenced by DlScheduling().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 48 of file mac-stats-calculator.cc.

References SetDlOutputFilename(), ns3::TypeId::SetParent(), and SetUlOutputFilename().

+ Here is the call graph for this function:

std::string ns3::MacStatsCalculator::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 74 of file mac-stats-calculator.cc.

References ns3::LteStatsCalculator::GetUlOutputFilename().

Referenced by UlScheduling().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::MacStatsCalculator::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 80 of file mac-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::MacStatsCalculator::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 68 of file mac-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::MacStatsCalculator::UlScheduling ( uint16_t  cellId,
uint64_t  imsi,
uint32_t  frameNo,
uint32_t  subframeNo,
uint16_t  rnti,
uint8_t  mcsTb,
uint16_t  sizeTb 
)

Notifies the stats calculator that an uplink scheduling has occurred.

Parameters
cellIdCell ID of the attached Enb
imsiIMSI of the scheduled UE
frameNoFrame number
subframeNoSubframe number
rntiC-RNTI scheduled
mcsTbMCS for transport block
sizeTbSize of transport block

Definition at line 135 of file mac-stats-calculator.cc.

References ns3::Time::GetNanoSeconds(), GetUlOutputFilename(), m_ulFirstWrite, ns3::Simulator::Now(), NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

void ns3::MacStatsCalculator::UlSchedulingCallback ( Ptr< MacStatsCalculator macStats,
std::string  path,
uint32_t  frameNo,
uint32_t  subframeNo,
uint16_t  rnti,
uint8_t  mcs,
uint16_t  size 
)
static

Trace sink for the ns3::LteEnbMac::UlScheduling trace source.

Parameters
macStats
path
frameNo
subframeNo
rnti
mcs
size

Definition at line 210 of file mac-stats-calculator.cc.

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

bool ns3::MacStatsCalculator::m_dlFirstWrite
private

Definition at line 150 of file mac-stats-calculator.h.

Referenced by DlScheduling().

bool ns3::MacStatsCalculator::m_ulFirstWrite
private

Definition at line 151 of file mac-stats-calculator.h.

Referenced by UlScheduling().


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