A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
radio-bearer-stats-calculator.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Jaume Nin <jnin@cttc.es>
18 * Nicola Baldo <nbaldo@cttc.es>
19 */
20
21#ifndef RADIO_BEARER_STATS_CALCULATOR_H_
22#define RADIO_BEARER_STATS_CALCULATOR_H_
23
25
26#include "ns3/basic-data-calculators.h"
27#include "ns3/lte-common.h"
28#include "ns3/object.h"
29#include "ns3/uinteger.h"
30
31#include <fstream>
32#include <map>
33#include <string>
34
35namespace ns3
36{
38typedef std::map<ImsiLcidPair_t, uint32_t> Uint32Map;
40typedef std::map<ImsiLcidPair_t, uint64_t> Uint64Map;
42typedef std::map<ImsiLcidPair_t, Ptr<MinMaxAvgTotalCalculator<uint32_t>>> Uint32StatsMap;
44typedef std::map<ImsiLcidPair_t, Ptr<MinMaxAvgTotalCalculator<uint64_t>>> Uint64StatsMap;
46typedef std::map<ImsiLcidPair_t, double> DoubleMap;
48typedef std::map<ImsiLcidPair_t, LteFlowId_t> FlowIdMap;
49
71{
72 public:
77
82 RadioBearerStatsCalculator(std::string protocolType);
83
89
90 // Inherited from ns3::Object
95 static TypeId GetTypeId();
96 void DoDispose() override;
97
102 std::string GetUlOutputFilename();
103
108 std::string GetDlOutputFilename();
109
115 void SetUlPdcpOutputFilename(std::string outputFilename);
116
121 std::string GetUlPdcpOutputFilename();
122
128 void SetDlPdcpOutputFilename(std::string outputFilename);
129
134 std::string GetDlPdcpOutputFilename();
135
140 void SetStartTime(Time t);
141
146 Time GetStartTime() const;
147
152 void SetEpoch(Time e);
153
158 Time GetEpoch() const;
159
168 void UlTxPdu(uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize);
169
179 void UlRxPdu(uint16_t cellId,
180 uint64_t imsi,
181 uint16_t rnti,
182 uint8_t lcid,
184 uint64_t delay);
185
194 void DlTxPdu(uint16_t cellId, uint64_t imsi, uint16_t rnti, uint8_t lcid, uint32_t packetSize);
195
205 void DlRxPdu(uint16_t cellId,
206 uint64_t imsi,
207 uint16_t rnti,
208 uint8_t lcid,
210 uint64_t delay);
211
218 uint32_t GetUlTxPackets(uint64_t imsi, uint8_t lcid);
219
226 uint32_t GetUlRxPackets(uint64_t imsi, uint8_t lcid);
227
234 uint64_t GetUlTxData(uint64_t imsi, uint8_t lcid);
235
242 uint64_t GetUlRxData(uint64_t imsi, uint8_t lcid);
243
250 uint32_t GetUlCellId(uint64_t imsi, uint8_t lcid);
251
258 double GetUlDelay(uint64_t imsi, uint8_t lcid);
259
266 std::vector<double> GetUlDelayStats(uint64_t imsi, uint8_t lcid);
267
274 std::vector<double> GetUlPduSizeStats(uint64_t imsi, uint8_t lcid);
275
282 uint32_t GetDlTxPackets(uint64_t imsi, uint8_t lcid);
283
290 uint32_t GetDlRxPackets(uint64_t imsi, uint8_t lcid);
291
298 uint64_t GetDlTxData(uint64_t imsi, uint8_t lcid);
299
306 uint64_t GetDlRxData(uint64_t imsi, uint8_t lcid);
307
314 uint32_t GetDlCellId(uint64_t imsi, uint8_t lcid);
315
322 double GetDlDelay(uint64_t imsi, uint8_t lcid);
323
330 std::vector<double> GetDlDelayStats(uint64_t imsi, uint8_t lcid);
331
338 std::vector<double> GetDlPduSizeStats(uint64_t imsi, uint8_t lcid);
339
340 private:
347 void ShowResults();
348
354 void WriteUlResults(std::ofstream& outFile);
355
361 void WriteDlResults(std::ofstream& outFile);
362
366 void ResetResults();
367
372 void RescheduleEndEpoch();
373
379 void EndEpoch();
380
382
384
392
400
405
410
415
420
424 std::string m_protocolType;
425
430
435};
436
437} // namespace ns3
438
439#endif /* RADIO_BEARER_STATS_CALCULATOR_H_ */
An identifier for simulation events.
Definition: event-id.h:55
Base class for ***StatsCalculator classes.
This class is an ns-3 trace sink that performs the calculation of PDU statistics for uplink and downl...
Uint32Map m_ulTxPackets
Number of UL TX Packets by (IMSI, LCID) pair.
Uint64StatsMap m_dlDelay
DL delay by (IMSI, LCID) pair.
std::vector< double > GetDlDelayStats(uint64_t imsi, uint8_t lcid)
Gets the downlink RLC to RLC statistics: average, min, max and standard deviation.
std::string m_protocolType
Protocol type, by default RLC.
Uint64Map m_dlRxData
Amount of DL RX Data by (IMSI, LCID) pair.
uint64_t GetDlTxData(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted downlink data bytes.
uint32_t GetUlRxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of received uplink packets.
~RadioBearerStatsCalculator() override
Class destructor.
uint32_t GetDlRxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of received downlink data bytes.
std::vector< double > GetDlPduSizeStats(uint64_t imsi, uint8_t lcid)
Gets the downlink PDU size statistics: average, min, max and standard deviation.
void RescheduleEndEpoch()
Reschedules EndEpoch event.
Uint64StatsMap m_ulDelay
UL delay by (IMSI, LCID) pair.
uint32_t GetUlCellId(uint64_t imsi, uint8_t lcid)
Gets the attached Enb cellId.
Uint64Map m_ulRxData
Amount of UL RX Data by (IMSI, LCID) pair.
void EndEpoch()
Function called in every endEpochEvent.
Time m_startTime
Start time of the on going epoch.
std::vector< double > GetUlPduSizeStats(uint64_t imsi, uint8_t lcid)
Gets the uplink PDU size statistics: average, min, max and standard deviation.
Uint64Map m_ulTxData
Amount of UL TX Data by (IMSI, LCID) pair.
std::string GetUlPdcpOutputFilename()
Get the name of the file where the uplink PDCP statistics will be stored.
void ShowResults()
Called after each epoch to write collected statistics to output files.
uint32_t GetDlTxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted downlink data bytes.
Uint32StatsMap m_ulPduSize
UL PDU Size by (IMSI, LCID) pair.
EventId m_endEpochEvent
Event id for next end epoch event.
void DoDispose() override
Destructor implementation.
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.
uint64_t GetUlRxData(uint64_t imsi, uint8_t lcid)
Gets the number of received uplink data bytes.
std::string m_dlPdcpOutputFilename
Name of the file where the downlink PDCP statistics will be saved.
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.
uint64_t GetDlRxData(uint64_t imsi, uint8_t lcid)
Gets the number of received downlink data bytes.
Uint32Map m_dlRxPackets
Number of DL RX Packets by (IMSI, LCID) pair.
std::string GetUlOutputFilename()
Get the name of the file where the uplink statistics will be stored.
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.
uint64_t GetUlTxData(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted uplink data bytes.
std::string GetDlOutputFilename()
Get the name of the file where the downlink statistics will be stored.
std::string m_ulPdcpOutputFilename
Name of the file where the uplink PDCP statistics will be saved.
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.
void ResetResults()
Erases collected statistics.
void WriteDlResults(std::ofstream &outFile)
Writes collected statistics to DL output file and closes DL output file.
Uint32StatsMap m_dlPduSize
DL PDU Size by (IMSI, LCID) pair.
Uint32Map m_ulRxPackets
Number of UL RX Packets by (IMSI, LCID) pair.
bool m_firstWrite
true if output files have not been opened yet
std::string GetDlPdcpOutputFilename()
Get the name of the file where the downlink PDCP statistics will be stored.
uint32_t GetDlCellId(uint64_t imsi, uint8_t lcid)
Gets the attached Enb cellId.
double GetDlDelay(uint64_t imsi, uint8_t lcid)
Gets the downlink RLC to RLC delay.
void WriteUlResults(std::ofstream &outFile)
Writes collected statistics to UL output file and closes UL output file.
double GetUlDelay(uint64_t imsi, uint8_t lcid)
Gets the uplink RLC to RLC delay.
void SetUlPdcpOutputFilename(std::string outputFilename)
Set the name of the file where the uplink PDCP statistics will be stored.
Uint32Map m_ulCellId
List of UL CellIds by (IMSI, LCID) pair.
uint32_t GetUlTxPackets(uint64_t imsi, uint8_t lcid)
Gets the number of transmitted uplink packets.
Uint32Map m_dlCellId
List of DL CellIds by (IMSI, LCID) pair.
std::vector< double > GetUlDelayStats(uint64_t imsi, uint8_t lcid)
Gets the uplink RLC to RLC statistics: average, min, max and standard deviation.
Uint32Map m_dlTxPackets
Number of DL TX Packets by (IMSI, LCID) pair.
bool m_pendingOutput
true if any output is pending
static TypeId GetTypeId()
Register this type.
Uint64Map m_dlTxData
Amount of DL TX Data by (IMSI, LCID) pair.
void SetDlPdcpOutputFilename(std::string outputFilename)
Set the name of the file where the downlink PDCP statistics will be stored.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::map< ImsiLcidPair_t, double > DoubleMap
Container: (IMSI, LCID) pair, double.
std::map< ImsiLcidPair_t, LteFlowId_t > FlowIdMap
Container: (IMSI, LCID) pair, LteFlowId_t.
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.
std::map< ImsiLcidPair_t, Ptr< MinMaxAvgTotalCalculator< uint64_t > > > Uint64StatsMap
Container: (IMSI, LCID) pair, uint64_t calculator.
std::map< ImsiLcidPair_t, Ptr< MinMaxAvgTotalCalculator< uint32_t > > > Uint32StatsMap
Container: (IMSI, LCID) pair, uint32_t calculator.
static const uint32_t packetSize
Packet size generated at the AP.