examples: Update documentation for wifi rates validation examples

This commit is contained in:
Sébastien Deronne
2024-12-31 12:42:59 +01:00
parent 187be11b17
commit d16d7e6cff
6 changed files with 25 additions and 25 deletions

View File

@@ -4,10 +4,10 @@
* Author: Sébastien Deronne <sebastien.deronne@gmail.com>
*/
// This example is used to validate error rate models for DSSS rates.
//
// It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio
// for the DSSS error rate models and for every DSSS mode.
// This example is used to generate plots of the Frame Success Rate (FSR) versus the Signal-to-noise
// ratio (SNR) for NIST, YANS and Table-based error rate models and for every DSSS rate. It also
// performs a boundary check to ensure that the FSR is between 0 and 1. The results are finally
// saved in files (.plt) per model which can be processed by gnuplot to generate the plots.
#include "ns3/command-line.h"
#include "ns3/gnuplot.h"

View File

@@ -6,10 +6,10 @@
* Author: Sébastien Deronne <sebastien.deronne@gmail.com>
*/
// This example is used to validate NIST and YANS error rate models for EHT rates.
//
// It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio for
// Nist, Yans and Table-based error rate models and for every HT MCS value.
// This example is used to generate plots of the Frame Success Rate (FSR) versus the Signal-to-noise
// ratio (SNR) for NIST, YANS and Table-based error rate models and for every EHT MCS value. It also
// performs a boundary check to ensure that the FSR is between 0 and 1. The results are finally
// saved in files (.plt) per model which can be processed by gnuplot to generate the plots.
#include "ns3/command-line.h"
#include "ns3/gnuplot.h"

View File

@@ -4,10 +4,10 @@
* Author: Sébastien Deronne <sebastien.deronne@gmail.com>
*/
// This example is used to validate Nist, Yans and Table-based error rate models for HE rates.
//
// It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio for
// Nist, Yans and Table-based error rate models and for every HE MCS value.
// This example is used to generate plots of the Frame Success Rate (FSR) versus the Signal-to-noise
// ratio (SNR) for NIST, YANS and Table-based error rate models and for every HE MCS value. It also
// performs a boundary check to ensure that the FSR is between 0 and 1. The results are finally
// saved in files (.plt) per model which can be processed by gnuplot to generate the plots.
#include "ns3/command-line.h"
#include "ns3/gnuplot.h"

View File

@@ -4,10 +4,10 @@
* Author: Sébastien Deronne <sebastien.deronne@gmail.com>
*/
// This example is used to validate Nist, Yans and Table-based error rate models for HT rates.
//
// It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio for
// Nist, Yans and Table-based error rate models and for every HT MCS value.
// This example is used to generate plots of the Frame Success Rate (FSR) versus the Signal-to-noise
// ratio (SNR) for NIST, YANS and Table-based error rate models and for every HT MCS value. It also
// performs a boundary check to ensure that the FSR is between 0 and 1. The results are finally
// saved in files (.plt) per model which can be processed by gnuplot to generate the plots.
#include "ns3/command-line.h"
#include "ns3/gnuplot.h"

View File

@@ -6,10 +6,10 @@
* Author: Gary Pei <guangyu.pei@boeing.com>
*/
// This example is used to validate Nist, Yans and Table-based error rate models for OFDM rates.
//
// It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio for
// Nist, Yans and Table-based error rate models and for every OFDM mode.
// This example is used to generate plots of the Frame Success Rate (FSR) versus the Signal-to-noise
// ratio (SNR) for NIST, YANS and Table-based error rate models and for every OFDM rate. It also
// performs a boundary check to ensure that the FSR is between 0 and 1. The results are finally
// saved in files (.plt) per model which can be processed by gnuplot to generate the plots.
#include "ns3/command-line.h"
#include "ns3/gnuplot.h"

View File

@@ -4,11 +4,11 @@
* Author: Sébastien Deronne <sebastien.deronne@gmail.com>
*/
// This example is used to validate Nist, Yans and Table-based error rate models for VHT rates.
//
// It outputs plots of the Frame Success Rate versus the Signal-to-noise ratio for
// Nist, Yans and Table-based error rate models and for every VHT MCS value (MCS 9 is not
// included since it is forbidden for 20 MHz channels).
// This example is used to generate plots of the Frame Success Rate (FSR) versus the Signal-to-noise
// ratio (SNR) for NIST, YANS and Table-based error rate models and for every VHT MCS value (MCS 9
// is not included since it is forbidden for 20 MHz channels). It also performs a boundary check to
// ensure that the FSR is between 0 and 1. The results are finally saved in files (.plt) per model
// which can be processed by gnuplot to generate the plots.
#include "ns3/command-line.h"
#include "ns3/gnuplot.h"