A Discrete-Event Network Simulator
API
wifi-ofdm-ht-validation.cc
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation;
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  *
15  * Author: Sébastien Deronne <sebastien.deronne@gmail.com>
16  */
17 
18 // This example is used to validate Nist, Yans and Table-based error rate models for HT rates.
19 //
20 // It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio for
21 // Nist, Yans and Table-based error rate models and for every HT MCS value.
22 
23 #include "ns3/command-line.h"
24 #include "ns3/gnuplot.h"
25 #include "ns3/nist-error-rate-model.h"
26 #include "ns3/table-based-error-rate-model.h"
27 #include "ns3/wifi-tx-vector.h"
28 #include "ns3/yans-error-rate-model.h"
29 
30 #include <cmath>
31 #include <fstream>
32 
33 using namespace ns3;
34 
35 int
36 main(int argc, char* argv[])
37 {
38  uint32_t frameSizeBytes = 1500;
39  std::ofstream yansfile("yans-frame-success-rate-n.plt");
40  std::ofstream nistfile("nist-frame-success-rate-n.plt");
41  std::ofstream tablefile("table-frame-success-rate-n.plt");
42 
43  const std::vector<std::string> modes{
44  "HtMcs0",
45  "HtMcs1",
46  "HtMcs2",
47  "HtMcs3",
48  "HtMcs4",
49  "HtMcs5",
50  "HtMcs6",
51  "HtMcs7",
52  };
53 
54  CommandLine cmd(__FILE__);
55  cmd.AddValue("FrameSize", "The frame size in bytes", frameSizeBytes);
56  cmd.Parse(argc, argv);
57 
58  Gnuplot yansplot = Gnuplot("yans-frame-success-rate-n.eps");
59  Gnuplot nistplot = Gnuplot("nist-frame-success-rate-n.eps");
60  Gnuplot tableplot = Gnuplot("table-frame-success-rate-n.eps");
61  WifiTxVector txVector;
62 
63  Ptr<YansErrorRateModel> yans = CreateObject<YansErrorRateModel>();
64  Ptr<NistErrorRateModel> nist = CreateObject<NistErrorRateModel>();
65  Ptr<TableBasedErrorRateModel> table = CreateObject<TableBasedErrorRateModel>();
66 
67  uint32_t frameSizeBits = frameSizeBytes * 8;
68 
69  for (const auto& mode : modes)
70  {
71  std::cout << mode << std::endl;
72  Gnuplot2dDataset yansdataset(mode);
73  Gnuplot2dDataset nistdataset(mode);
74  Gnuplot2dDataset tabledataset(mode);
75  txVector.SetMode(mode);
76 
77  WifiMode wifiMode(mode);
78 
79  for (double snrDb = -5.0; snrDb <= 30.0; snrDb += 0.1)
80  {
81  double snr = std::pow(10.0, snrDb / 10.0);
82 
83  double ps = yans->GetChunkSuccessRate(wifiMode, txVector, snr, frameSizeBits);
84  if (ps < 0.0 || ps > 1.0)
85  {
86  // error
87  exit(1);
88  }
89  yansdataset.Add(snrDb, ps);
90 
91  ps = nist->GetChunkSuccessRate(wifiMode, txVector, snr, frameSizeBits);
92  if (ps < 0.0 || ps > 1.0)
93  {
94  // error
95  exit(1);
96  }
97  nistdataset.Add(snrDb, ps);
98 
99  ps = table->GetChunkSuccessRate(wifiMode, txVector, snr, frameSizeBits);
100  if (ps < 0.0 || ps > 1.0)
101  {
102  // error
103  exit(1);
104  }
105  tabledataset.Add(snrDb, ps);
106  }
107 
108  yansplot.AddDataset(yansdataset);
109  nistplot.AddDataset(nistdataset);
110  tableplot.AddDataset(tabledataset);
111  }
112 
113  yansplot.SetTerminal("postscript eps color enh \"Times-BoldItalic\"");
114  yansplot.SetLegend("SNR(dB)", "Frame Success Rate");
115  yansplot.SetExtra("set xrange [-5:30]\n\
116 set yrange [0:1.2]\n\
117 set style line 1 linewidth 5\n\
118 set style line 2 linewidth 5\n\
119 set style line 3 linewidth 5\n\
120 set style line 4 linewidth 5\n\
121 set style line 5 linewidth 5\n\
122 set style line 6 linewidth 5\n\
123 set style line 7 linewidth 5\n\
124 set style line 8 linewidth 5\n\
125 set style increment user");
126  yansplot.GenerateOutput(yansfile);
127  yansfile.close();
128 
129  nistplot.SetTerminal("postscript eps color enh \"Times-BoldItalic\"");
130  nistplot.SetLegend("SNR(dB)", "Frame Success Rate");
131  nistplot.SetExtra("set xrange [-5:30]\n\
132 set yrange [0:1.2]\n\
133 set style line 1 linewidth 5\n\
134 set style line 2 linewidth 5\n\
135 set style line 3 linewidth 5\n\
136 set style line 4 linewidth 5\n\
137 set style line 5 linewidth 5\n\
138 set style line 6 linewidth 5\n\
139 set style line 7 linewidth 5\n\
140 set style line 8 linewidth 5\n\
141 set style increment user");
142 
143  nistplot.GenerateOutput(nistfile);
144  nistfile.close();
145 
146  tableplot.SetTerminal("postscript eps color enh \"Times-BoldItalic\"");
147  tableplot.SetLegend("SNR(dB)", "Frame Success Rate");
148  tableplot.SetExtra("set xrange [-5:30]\n\
149 set yrange [0:1.2]\n\
150 set style line 1 linewidth 5\n\
151 set style line 2 linewidth 5\n\
152 set style line 3 linewidth 5\n\
153 set style line 4 linewidth 5\n\
154 set style line 5 linewidth 5\n\
155 set style line 6 linewidth 5\n\
156 set style line 7 linewidth 5\n\
157 set style line 8 linewidth 5\n\
158 set style increment user");
159 
160  tableplot.GenerateOutput(tablefile);
161  tablefile.close();
162 
163  return 0;
164 }
Parse command-line arguments.
Definition: command-line.h:232
Class to represent a 2D points plot.
Definition: gnuplot.h:118
a simple class to generate gnuplot-ready plotting commands from a set of datasets.
Definition: gnuplot.h:373
void AddDataset(const GnuplotDataset &dataset)
Definition: gnuplot.cc:759
void SetLegend(const std::string &xLegend, const std::string &yLegend)
Definition: gnuplot.cc:739
void SetTerminal(const std::string &terminal)
Definition: gnuplot.cc:727
void GenerateOutput(std::ostream &os)
Writes gnuplot commands and data values to a single output stream.
Definition: gnuplot.cc:765
void SetExtra(const std::string &extra)
Definition: gnuplot.cc:746
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
represent a single transmission mode
Definition: wifi-mode.h:51
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void SetMode(WifiMode mode)
Sets the selected payload transmission mode.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:40