A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
phy-rx-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 PhyRxStatsCalculator
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 ("PhyRxStatsCalculator");
31 
32 NS_OBJECT_ENSURE_REGISTERED (PhyRxStatsCalculator);
33 
35  : m_dlRxFirstWrite (true),
36  m_ulRxFirstWrite (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::PhyRxStatsCalculator")
52  .SetGroupName("Lte")
53  .AddConstructor<PhyRxStatsCalculator> ()
54  .AddAttribute ("DlRxOutputFilename",
55  "Name of the file where the downlink results will be saved.",
56  StringValue ("DlRxPhyStats.txt"),
59  .AddAttribute ("UlRxOutputFilename",
60  "Name of the file where the uplink results will be saved.",
61  StringValue ("UlRxPhyStats.txt"),
64  ;
65  return tid;
66 }
67 
68 void
69 PhyRxStatsCalculator::SetUlRxOutputFilename (std::string outputFilename)
70 {
72 }
73 
74 std::string
76 {
78 }
79 
80 void
81 PhyRxStatsCalculator::SetDlRxOutputFilename (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 << params.m_correctness);
96  NS_LOG_INFO ("Write DL Rx Phy Stats in " << GetDlRxOutputFilename ().c_str ());
97 
98  std::ofstream outFile;
99  if ( m_dlRxFirstWrite == true )
100  {
101  outFile.open (GetDlRxOutputFilename ().c_str ());
102  if (!outFile.is_open ())
103  {
104  NS_LOG_ERROR ("Can't open file " << GetDlRxOutputFilename ().c_str ());
105  return;
106  }
107  m_dlRxFirstWrite = false;
108  outFile << "% time\tcellId\tIMSI\tRNTI\ttxMode\tlayer\tmcs\tsize\trv\tndi\tcorrect";
109  outFile << std::endl;
110  }
111  else
112  {
113  outFile.open (GetDlRxOutputFilename ().c_str (), std::ios_base::app);
114  if (!outFile.is_open ())
115  {
116  NS_LOG_ERROR ("Can't open file " << GetDlRxOutputFilename ().c_str ());
117  return;
118  }
119  }
120 
121 // outFile << Simulator::Now ().GetNanoSeconds () / (double) 1e9 << "\t";
122  outFile << params.m_timestamp << "\t";
123  outFile << (uint32_t) params.m_cellId << "\t";
124  outFile << params.m_imsi << "\t";
125  outFile << params.m_rnti << "\t";
126  outFile << (uint32_t) params.m_txMode << "\t";
127  outFile << (uint32_t) params.m_layer << "\t";
128  outFile << (uint32_t) params.m_mcs << "\t";
129  outFile << params.m_size << "\t";
130  outFile << (uint32_t) params.m_rv << "\t";
131  outFile << (uint32_t) params.m_ndi << "\t";
132  outFile << (uint32_t) params.m_correctness << 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 << params.m_correctness);
140  NS_LOG_INFO ("Write UL Rx Phy Stats in " << GetUlRxOutputFilename ().c_str ());
141 
142  std::ofstream outFile;
143  if ( m_ulRxFirstWrite == true )
144  {
145  outFile.open (GetUlRxOutputFilename ().c_str ());
146  if (!outFile.is_open ())
147  {
148  NS_LOG_ERROR ("Can't open file " << GetUlRxOutputFilename ().c_str ());
149  return;
150  }
151  m_ulRxFirstWrite = false;
152  outFile << "% time\tcellId\tIMSI\tRNTI\tlayer\tmcs\tsize\trv\tndi\tcorrect";
153  outFile << std::endl;
154  }
155  else
156  {
157  outFile.open (GetUlRxOutputFilename ().c_str (), std::ios_base::app);
158  if (!outFile.is_open ())
159  {
160  NS_LOG_ERROR ("Can't open file " << GetUlRxOutputFilename ().c_str ());
161  return;
162  }
163  }
164 
165 // outFile << Simulator::Now ().GetNanoSeconds () / (double) 1e9 << "\t";
166  outFile << params.m_timestamp << "\t";
167  outFile << (uint32_t) params.m_cellId << "\t";
168  outFile << params.m_imsi << "\t";
169  outFile << params.m_rnti << "\t";
170  outFile << (uint32_t) params.m_layer << "\t";
171  outFile << (uint32_t) params.m_mcs << "\t";
172  outFile << params.m_size << "\t";
173  outFile << (uint32_t) params.m_rv << "\t";
174  outFile << (uint32_t) params.m_ndi << "\t";
175  outFile << (uint32_t) params.m_correctness << std::endl;
176  outFile.close ();
177 }
178 
179 void
181  std::string path, PhyReceptionStatParameters params)
182 {
183  NS_LOG_FUNCTION (phyRxStats << path);
184  uint64_t imsi = 0;
185  std::ostringstream pathAndRnti;
186  pathAndRnti << path << "/" << params.m_rnti;
187  if (phyRxStats->ExistsImsiPath (pathAndRnti.str ()) == true)
188  {
189  imsi = phyRxStats->GetImsiPath (pathAndRnti.str ());
190  }
191  else
192  {
193  imsi = FindImsiForUe (path, params.m_rnti);
194  phyRxStats->SetImsiPath (pathAndRnti.str (), imsi);
195  }
196 
197  params.m_imsi = imsi;
198  phyRxStats->DlPhyReception (params);
199 }
200 
201 void
203  std::string path, PhyReceptionStatParameters params)
204 {
205  NS_LOG_FUNCTION (phyRxStats << path);
206  uint64_t imsi = 0;
207  std::ostringstream pathAndRnti;
208  pathAndRnti << path << "/" << params.m_rnti;
209  if (phyRxStats->ExistsImsiPath (pathAndRnti.str ()) == true)
210  {
211  imsi = phyRxStats->GetImsiPath (pathAndRnti.str ());
212  }
213  else
214  {
215  imsi = FindImsiForEnb (path, params.m_rnti);
216  phyRxStats->SetImsiPath (pathAndRnti.str (), imsi);
217  }
218 
219  params.m_imsi = imsi;
220  phyRxStats->UlPhyReception (params);
221 }
222 
223 } // namespace ns3
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 "...
uint8_t m_mcs
MCS for transport block.
Definition: lte-common.h:150
#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_dlRxFirstWrite
When writing DL RX PHY statistics first time to file, columns description is added.
uint8_t m_rv
the redundancy version (HARQ)
Definition: lte-common.h:152
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
void DlPhyReception(PhyReceptionStatParameters params)
Notifies the stats calculator that an downlink reception has occurred.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:244
std::string GetUlRxOutputFilename(void)
Get the name of the file where the UL RX PHY statistics will be stored.
void SetUlOutputFilename(std::string outputFilename)
Set the name of the file where the uplink statistics will be stored.
virtual ~PhyRxStatsCalculator()
Destructor.
static uint64_t FindImsiForEnb(std::string path, uint16_t rnti)
Retrieves IMSI from path for Enb in the attribute system.
void UlPhyReception(PhyReceptionStatParameters params)
Notifies the stats calculator that an uplink reception has occurred.
uint8_t m_layer
the layer (cw) of the transmission
Definition: lte-common.h:149
std::string GetUlOutputFilename(void)
Get the name of the file where the uplink statistics will be stored.
uint8_t m_ndi
new data indicator flag
Definition: lte-common.h:153
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.
uint8_t m_txMode
the transmission Mode
Definition: lte-common.h:148
uint16_t m_size
Size of transport block.
Definition: lte-common.h:151
static void DlPhyReceptionCallback(Ptr< PhyRxStatsCalculator > phyRxStats, std::string path, PhyReceptionStatParameters params)
trace sink
static void UlPhyReceptionCallback(Ptr< PhyRxStatsCalculator > phyRxStats, std::string path, PhyReceptionStatParameters params)
trace sink
uint8_t m_correctness
correctness of the TB received
Definition: lte-common.h:154
uint16_t m_rnti
C-RNTI scheduled.
Definition: lte-common.h:147
uint16_t m_cellId
Cell ID of the attached Enb.
Definition: lte-common.h:145
std::string GetDlRxOutputFilename(void)
Get the name of the file where the DL RX 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
void SetUlRxOutputFilename(std::string outputFilename)
Set the name of the file where the UL Rx PHY statistics will be stored.
void SetDlRxOutputFilename(std::string outputFilename)
Set the name of the file where the DL RX PHY statistics will be stored.
uint64_t m_imsi
IMSI of the scheduled UE.
Definition: lte-common.h:146
static TypeId GetTypeId(void)
Register this type.
a unique identifier for an interface.
Definition: type-id.h:58
bool m_ulRxFirstWrite
When writing UL RX PHY statistics first time to file, columns description is added.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:827
Takes care of storing the information generated at PHY layer regarding reception. ...
std::string GetDlOutputFilename(void)
Get the name of the file where the downlink statistics will be stored.