A Discrete-Event Network Simulator
API
radio-bearer-stats-calculator.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Jaume Nin <jnin@cttc.es>
19  * Nicola Baldo <nbaldo@cttc.es>
20  */
21 
22 #ifndef RADIO_BEARER_STATS_CALCULATOR_H_
23 #define RADIO_BEARER_STATS_CALCULATOR_H_
24 
25 #include "ns3/lte-stats-calculator.h"
26 #include "ns3/lte-common.h"
27 #include "ns3/uinteger.h"
28 #include "ns3/object.h"
29 #include "ns3/basic-data-calculators.h"
30 #include "ns3/lte-common.h"
31 #include <string>
32 #include <map>
33 #include <fstream>
34 
35 namespace ns3
36 {
38 typedef std::map<ImsiLcidPair_t, uint32_t> Uint32Map;
40 typedef std::map<ImsiLcidPair_t, uint64_t> Uint64Map;
42 typedef std::map<ImsiLcidPair_t, Ptr<MinMaxAvgTotalCalculator<uint32_t> > > Uint32StatsMap;
44 typedef std::map<ImsiLcidPair_t, Ptr<MinMaxAvgTotalCalculator<uint64_t> > > Uint64StatsMap;
46 typedef std::map<ImsiLcidPair_t, double> DoubleMap;
48 typedef std::map<ImsiLcidPair_t, LteFlowId_t> FlowIdMap;
49 
71 {
72 public:
77 
82  RadioBearerStatsCalculator (std::string protocolType);
83 
87  virtual
89 
90  // Inherited from ns3::Object
95  static TypeId GetTypeId (void);
96  void DoDispose ();
97 
102  std::string GetUlOutputFilename (void);
103 
108  std::string GetDlOutputFilename (void);
109 
115  void SetUlPdcpOutputFilename (std::string outputFilename);
116 
121  std::string GetUlPdcpOutputFilename (void);
122 
128  void SetDlPdcpOutputFilename (std::string outputFilename);
129 
134  std::string GetDlPdcpOutputFilename (void);
135 
136 
141  void SetStartTime (Time t);
142 
147  Time GetStartTime () const;
148 
153  void SetEpoch (Time e);
154 
159  Time GetEpoch () const;
160 
169  void
170  UlTxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize);
171 
181  void
182  UlRxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize, uint64_t delay);
183 
192  void
193  DlTxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize);
194 
204  void
205  DlRxPdu (uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize, uint64_t delay);
206 
213  uint32_t
214  GetUlTxPackets (uint64_t imsi, uint8_t lcid);
215 
222  uint32_t
223  GetUlRxPackets (uint64_t imsi, uint8_t lcid);
224 
231  uint64_t
232  GetUlTxData (uint64_t imsi, uint8_t lcid);
233 
240  uint64_t
241  GetUlRxData (uint64_t imsi, uint8_t lcid);
242 
249  uint32_t
250  GetUlCellId (uint64_t imsi, uint8_t lcid);
251 
258  double
259  GetUlDelay (uint64_t imsi, uint8_t lcid);
260 
267  std::vector<double>
268  GetUlDelayStats (uint64_t imsi, uint8_t lcid);
269 
276  std::vector<double>
277  GetUlPduSizeStats (uint64_t imsi, uint8_t lcid);
278 
285  uint32_t
286  GetDlTxPackets (uint64_t imsi, uint8_t lcid);
287 
294  uint32_t
295  GetDlRxPackets (uint64_t imsi, uint8_t lcid);
296 
303  uint64_t
304  GetDlTxData (uint64_t imsi, uint8_t lcid);
305 
312  uint64_t
313  GetDlRxData (uint64_t imsi, uint8_t lcid);
314 
321  uint32_t
322  GetDlCellId (uint64_t imsi, uint8_t lcid);
323 
330  double
331  GetDlDelay (uint64_t imsi, uint8_t lcid);
332 
339  std::vector<double>
340  GetDlDelayStats (uint64_t imsi, uint8_t lcid);
341 
348  std::vector<double>
349  GetDlPduSizeStats (uint64_t imsi, uint8_t lcid);
350 
351 private:
358  void
359  ShowResults (void);
360 
366  void
367  WriteUlResults (std::ofstream& outFile);
368 
374  void
375  WriteDlResults (std::ofstream& outFile);
376 
380  void
381  ResetResults (void);
382 
387  void RescheduleEndEpoch ();
388 
394  void EndEpoch (void);
395 
397 
399 
407 
415 
420 
425 
430 
435 
439  std::string m_protocolType;
440 
445 
450 
451 };
452 
453 } // namespace ns3
454 
455 #endif /* RADIO_BEARER_STATS_CALCULATOR_H_ */
Base class for ***StatsCalculator classes.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
std::map< ImsiLcidPair_t, uint32_t > Uint32Map
Container: (IMSI, LCID) pair, uint32_t.
std::map< ImsiLcidPair_t, uint64_t > Uint64Map
Container: (IMSI, LCID) pair, uint64_t.
virtual ~RadioBearerStatsCalculator()
Class destructor.
std::string GetDlOutputFilename(void)
Get the name of the file where the downlink statistics will be stored.
static TypeId GetTypeId(void)
Register this type.
double GetUlDelay(uint64_t imsi, uint8_t lcid)
Gets the uplink RLC to RLC delay.
std::string GetUlPdcpOutputFilename(void)
Get the name of the file where the uplink PDCP statistics will be stored.
bool m_pendingOutput
true if any output is pending
Uint64Map m_dlRxData
Amount of DL RX Data by (IMSI, LCID) pair.
Uint32Map m_ulRxPackets
Number of UL RX Packets by (IMSI, LCID) pair.
Uint64Map m_ulRxData
Amount of UL RX Data by (IMSI, LCID) pair.
uint32_t GetDlRxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of received downlink data bytes.
FlowIdMap m_flowId
List of FlowIds, ie.
Uint64Map m_ulTxData
Amount of UL TX Data by (IMSI, LCID) pair.
uint32_t GetUlCellId(uint64_t imsi, uint8_t lcid)
Gets the attached Enb cellId.
void WriteDlResults(std::ofstream &outFile)
Writes collected statistics to DL output file and closes DL output file.
Uint32Map m_dlRxPackets
Number of DL RX Packets by (IMSI, LCID) pair.
void DoDispose()
Destructor implementation.
uint32_t GetUlTxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted uplink packets.
std::vector< double > GetUlPduSizeStats(uint64_t imsi, uint8_t lcid)
Gets the uplink PDU size statistics: average, min, max and standard deviation.
void WriteUlResults(std::ofstream &outFile)
Writes collected statistics to UL output file and closes UL output file.
uint64_t GetDlRxData(uint64_t imsi, uint8_t lcid)
Gets the number of received downlink data bytes.
void SetUlPdcpOutputFilename(std::string outputFilename)
Set the name of the file where the uplink PDCP statistics will be stored.
double GetDlDelay(uint64_t imsi, uint8_t lcid)
Gets the downlink RLC to RLC delay.
Uint32Map m_dlTxPackets
Number of DL TX Packets by (IMSI, LCID) pair.
std::map< ImsiLcidPair_t, Ptr< MinMaxAvgTotalCalculator< uint32_t > > > Uint32StatsMap
Container: (IMSI, LCID) pair, uint32_t calculator.
void UlTxPdu(uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize)
Notifies the stats calculator that an uplink transmission has occurred.
Uint64Map m_dlTxData
Amount of DL TX Data by (IMSI, LCID) pair.
Uint32Map m_ulTxPackets
Number of UL TX Packets by (IMSI, LCID) pair.
std::string GetDlPdcpOutputFilename(void)
Get the name of the file where the downlink PDCP statistics will be stored.
Uint64StatsMap m_ulDelay
UL delay by (IMSI, LCID) pair.
EventId m_endEpochEvent
Event id for next end epoch event.
uint32_t GetUlRxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of received uplink packets.
std::map< ImsiLcidPair_t, Ptr< MinMaxAvgTotalCalculator< uint64_t > > > Uint64StatsMap
Container: (IMSI, LCID) pair, uint64_t calculator.
Time m_startTime
Start time of the on going epoch.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Uint64StatsMap m_dlDelay
DL delay by (IMSI, LCID) pair.
std::string GetUlOutputFilename(void)
Get the name of the file where the uplink statistics will be stored.
bool m_firstWrite
true if output files have not been opened yet
uint64_t GetDlTxData(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted downlink data bytes.
void DlTxPdu(uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize)
Notifies the stats calculator that an downlink transmission has occurred.
uint32_t GetDlCellId(uint64_t imsi, uint8_t lcid)
Gets the attached Enb cellId.
void UlRxPdu(uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize, uint64_t delay)
Notifies the stats calculator that an uplink reception has occurred.
void ResetResults(void)
Erases collected statistics.
Uint32StatsMap m_ulPduSize
UL PDU Size by (IMSI, LCID) pair.
std::string m_protocolType
Protocol type, by default RLC.
uint64_t GetUlTxData(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted uplink data bytes.
uint64_t GetUlRxData(uint64_t imsi, uint8_t lcid)
Gets the number of received uplink data bytes.
std::vector< double > GetDlDelayStats(uint64_t imsi, uint8_t lcid)
Gets the downlink RLC to RLC statistics: average, min, max and standard deviation.
An identifier for simulation events.
Definition: event-id.h:53
uint32_t GetDlTxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted downlink data bytes.
void ShowResults(void)
Called after each epoch to write collected statistics to output files.
void RescheduleEndEpoch()
Reschedules EndEpoch event.
void SetDlPdcpOutputFilename(std::string outputFilename)
Set the name of the file where the downlink PDCP statistics will be stored.
static const uint32_t packetSize
Uint32Map m_dlCellId
List of DL CellIds by (IMSI, LCID) pair.
std::map< ImsiLcidPair_t, LteFlowId_t > FlowIdMap
Container: (IMSI, LCID) pair, LteFlowId_t.
void EndEpoch(void)
Function called in every endEpochEvent.
std::vector< double > GetUlDelayStats(uint64_t imsi, uint8_t lcid)
Gets the uplink RLC to RLC statistics: average, min, max and standard deviation.
This class is an ns-3 trace sink that performs the calculation of PDU statistics for uplink and downl...
std::vector< double > GetDlPduSizeStats(uint64_t imsi, uint8_t lcid)
Gets the downlink PDU size statistics: average, min, max and standard deviation.
std::string m_ulPdcpOutputFilename
Name of the file where the uplink PDCP statistics will be saved.
a unique identifier for an interface.
Definition: type-id.h:58
Uint32StatsMap m_dlPduSize
DL PDU Size by (IMSI, LCID) pair.
void DlRxPdu(uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize, uint64_t delay)
Notifies the stats calculator that an downlink reception has occurred.
Uint32Map m_ulCellId
List of UL CellIds by (IMSI, LCID) pair.
std::map< ImsiLcidPair_t, double > DoubleMap
Container: (IMSI, LCID) pair, double.
std::string m_dlPdcpOutputFilename
Name of the file where the downlink PDCP statistics will be saved.