A Discrete-Event Network Simulator
API
phy-tx-stats-calculator.cc
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  * modified by: Marco Miozzo <mmiozzo@cttc.es>
20  * Convert MacStatsCalculator in PhyTxStatsCalculator
21  */
22 
24 #include "ns3/string.h"
25 #include <ns3/simulator.h>
26 #include <ns3/log.h>
27 
28 namespace ns3 {
29 
30 NS_LOG_COMPONENT_DEFINE ("PhyTxStatsCalculator");
31 
32 NS_OBJECT_ENSURE_REGISTERED (PhyTxStatsCalculator);
33 
35  : m_dlTxFirstWrite (true),
36  m_ulTxFirstWrite (true)
37 {
38  NS_LOG_FUNCTION (this);
39 
40 }
41 
43 {
44  NS_LOG_FUNCTION (this);
45 }
46 
47 TypeId
49 {
50  static TypeId tid = TypeId ("ns3::PhyTxStatsCalculator")
52  .SetGroupName("Lte")
53  .AddConstructor<PhyTxStatsCalculator> ()
54  .AddAttribute ("DlTxOutputFilename",
55  "Name of the file where the downlink results will be saved.",
56  StringValue ("DlTxPhyStats.txt"),
59  .AddAttribute ("UlTxOutputFilename",
60  "Name of the file where the uplink results will be saved.",
61  StringValue ("UlTxPhyStats.txt"),
64  ;
65  return tid;
66 }
67 
68 void
69 PhyTxStatsCalculator::SetUlTxOutputFilename (std::string outputFilename)
70 {
72 }
73 
74 std::string
76 {
78 }
79 
80 void
81 PhyTxStatsCalculator::SetDlTxOutputFilename (std::string outputFilename)
82 {
84 }
85 
86 std::string
88 {
90 }
91 
92 void
94 {
95  NS_LOG_FUNCTION (this << params.m_cellId << params.m_imsi << params.m_timestamp << params.m_rnti << params.m_layer << params.m_mcs << params.m_size << params.m_rv << params.m_ndi);
96  NS_LOG_INFO ("Write DL Tx Phy Stats in " << GetDlTxOutputFilename ().c_str ());
97 
98  std::ofstream outFile;
99  if ( m_dlTxFirstWrite == true )
100  {
101  outFile.open (GetDlOutputFilename ().c_str ());
102  if (!outFile.is_open ())
103  {
104  NS_LOG_ERROR ("Can't open file " << GetDlTxOutputFilename ().c_str ());
105  return;
106  }
107  m_dlTxFirstWrite = false;
108  //outFile << "% time\tcellId\tIMSI\tRNTI\tlayer\tmcs\tsize\trv\tndi"; // txMode is not available at dl tx side
109  outFile << "% time\tcellId\tIMSI\tRNTI\tlayer\tmcs\tsize\trv\tndi";
110  outFile << std::endl;
111  }
112  else
113  {
114  outFile.open (GetDlTxOutputFilename ().c_str (), std::ios_base::app);
115  if (!outFile.is_open ())
116  {
117  NS_LOG_ERROR ("Can't open file " << GetDlTxOutputFilename ().c_str ());
118  return;
119  }
120  }
121 
122 // outFile << Simulator::Now ().GetNanoSeconds () / (double) 1e9 << "\t";
123  outFile << params.m_timestamp << "\t";
124  outFile << (uint32_t) params.m_cellId << "\t";
125  outFile << params.m_imsi << "\t";
126  outFile << params.m_rnti << "\t";
127  //outFile << (uint32_t) params.m_txMode << "\t"; // txMode is not available at dl tx side
128  outFile << (uint32_t) params.m_layer << "\t";
129  outFile << (uint32_t) params.m_mcs << "\t";
130  outFile << params.m_size << "\t";
131  outFile << (uint32_t) params.m_rv << "\t";
132  outFile << (uint32_t) params.m_ndi << std::endl;
133  outFile.close ();
134 }
135 
136 void
138 {
139  NS_LOG_FUNCTION (this << params.m_cellId << params.m_imsi << params.m_timestamp << params.m_rnti << params.m_layer << params.m_mcs << params.m_size << params.m_rv << params.m_ndi);
140  NS_LOG_INFO ("Write UL Tx Phy Stats in " << GetUlTxOutputFilename ().c_str ());
141 
142  std::ofstream outFile;
143  if ( m_ulTxFirstWrite == true )
144  {
145  outFile.open (GetUlTxOutputFilename ().c_str ());
146  if (!outFile.is_open ())
147  {
148  NS_LOG_ERROR ("Can't open file " << GetUlTxOutputFilename ().c_str ());
149  return;
150  }
151  m_ulTxFirstWrite = false;
152 // outFile << "% time\tcellId\tIMSI\tRNTI\ttxMode\tlayer\tmcs\tsize\trv\tndi";
153  outFile << "% time\tcellId\tIMSI\tRNTI\tlayer\tmcs\tsize\trv\tndi";
154  outFile << std::endl;
155  }
156  else
157  {
158  outFile.open (GetUlTxOutputFilename ().c_str (), std::ios_base::app);
159  if (!outFile.is_open ())
160  {
161  NS_LOG_ERROR ("Can't open file " << GetUlTxOutputFilename ().c_str ());
162  return;
163  }
164  }
165 
166 // outFile << Simulator::Now ().GetNanoSeconds () / (double) 1e9 << "\t";
167  outFile << params.m_timestamp << "\t";
168  outFile << (uint32_t) params.m_cellId << "\t";
169  outFile << params.m_imsi << "\t";
170  outFile << params.m_rnti << "\t";
171  //outFile << (uint32_t) params.m_txMode << "\t";
172  outFile << (uint32_t) params.m_layer << "\t";
173  outFile << (uint32_t) params.m_mcs << "\t";
174  outFile << params.m_size << "\t";
175  outFile << (uint32_t) params.m_rv << "\t";
176  outFile << (uint32_t) params.m_ndi << std::endl;
177  outFile.close ();
178 }
179 
180 void
182  std::string path, PhyTransmissionStatParameters params)
183 {
184  NS_LOG_FUNCTION (phyTxStats << path);
185  uint64_t imsi = 0;
186  std::ostringstream pathAndRnti;
187  pathAndRnti << path << "/" << params.m_rnti;
188  if (phyTxStats->ExistsImsiPath (pathAndRnti.str ()) == true)
189  {
190  imsi = phyTxStats->GetImsiPath (pathAndRnti.str ());
191  }
192  else
193  {
194  imsi = FindImsiForEnb (path, params.m_rnti);
195  phyTxStats->SetImsiPath (pathAndRnti.str (), imsi);
196  }
197 
198  params.m_imsi = imsi;
199  phyTxStats->DlPhyTransmission (params);
200 }
201 
202 void
204  std::string path, PhyTransmissionStatParameters params)
205 {
206  NS_LOG_FUNCTION (phyTxStats << path);
207  uint64_t imsi = 0;
208  std::ostringstream pathAndRnti;
209  pathAndRnti << path << "/" << params.m_rnti;
210  if (phyTxStats->ExistsImsiPath (pathAndRnti.str ()) == true)
211  {
212  imsi = phyTxStats->GetImsiPath (pathAndRnti.str ());
213  }
214  else
215  {
216  imsi = FindImsiForUe (path, params.m_rnti);
217  phyTxStats->SetImsiPath (pathAndRnti.str (), imsi);
218  }
219 
220  params.m_imsi = imsi;
221  phyTxStats->UlPhyTransmission (params);
222 }
223 
224 
225 } // namespace ns3
226 
Ptr< const AttributeChecker > MakeStringChecker(void)
Definition: string.cc:30
Base class for ***StatsCalculator classes.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
Hold variables of type string.
Definition: string.h:41
bool m_dlTxFirstWrite
When writing DL TX PHY statistics first time to file, columns description is added.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:244
uint8_t m_rv
the redundancy version (HARQ)
Definition: lte-common.h:128
void SetUlOutputFilename(std::string outputFilename)
Set the name of the file where the uplink statistics will be stored.
uint64_t m_imsi
IMSI of the scheduled UE.
Definition: lte-common.h:122
static uint64_t FindImsiForEnb(std::string path, uint16_t rnti)
Retrieves IMSI from path for Enb in the attribute system.
void SetDlTxOutputFilename(std::string outputFilename)
Set the name of the file where the DL TX PHY statistics will be stored.
std::string GetDlTxOutputFilename(void)
Get the name of the file where the DL TX PHY statistics will be stored.
void DlPhyTransmission(PhyTransmissionStatParameters params)
Notifies the stats calculator that an downlink trasmission has occurred.
uint8_t m_mcs
MCS for transport block.
Definition: lte-common.h:126
std::string GetUlTxOutputFilename(void)
Get the name of the file where the UL RX PHY statistics will be stored.
std::string GetUlOutputFilename(void)
Get the name of the file where the uplink statistics will be stored.
Takes care of storing the information generated at PHY layer regarding transmission.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool m_ulTxFirstWrite
When writing UL TX PHY statistics first time to file, columns description is added.
static void DlPhyTransmissionCallback(Ptr< PhyTxStatsCalculator > phyTxStats, std::string path, PhyTransmissionStatParameters params)
trace sink
void SetDlOutputFilename(std::string outputFilename)
Set the name of the file where the downlink statistics will be stored.
static uint64_t FindImsiForUe(std::string path, uint16_t rnti)
Retrieves IMSI from path for Ue in the attribute system.
uint16_t m_size
Size of transport block.
Definition: lte-common.h:127
virtual ~PhyTxStatsCalculator()
Destructor.
uint8_t m_ndi
new data indicator flag
Definition: lte-common.h:129
static void UlPhyTransmissionCallback(Ptr< PhyTxStatsCalculator > phyTxStats, std::string path, PhyTransmissionStatParameters params)
trace sink
uint16_t m_cellId
Cell ID of the attached Enb.
Definition: lte-common.h:121
uint8_t m_layer
the layer (cw) of the transmission
Definition: lte-common.h:125
void SetUlTxOutputFilename(std::string outputFilename)
Set the name of the file where the UL Tx PHY statistics will be stored.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:220
Ptr< const AttributeAccessor > MakeStringAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: string.h:42
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:904
uint16_t m_rnti
C-RNTI scheduled.
Definition: lte-common.h:123
static TypeId GetTypeId(void)
Register this type.
void UlPhyTransmission(PhyTransmissionStatParameters params)
Notifies the stats calculator that an uplink trasmission has occurred.
std::string GetDlOutputFilename(void)
Get the name of the file where the downlink statistics will be stored.