A Discrete-Event Network Simulator
API
table-based-error-rate-model.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2020 University of Washington
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 * Authors: Rohan Patidar <rpatidar@uw.edu>
19 * S├ębastien Deronne <sebastien.deronne@gmail.com>
20 */
21
22#ifndef TABLE_BASED_ERROR_RATE_MODEL_H
23#define TABLE_BASED_ERROR_RATE_MODEL_H
24
25#include "ns3/error-rate-tables.h"
26#include "error-rate-model.h"
27#include "wifi-mode.h"
28#include <optional>
29
30namespace ns3 {
31
32class WifiTxVector;
33
34/*
35 * \ingroup wifi
36 * \brief the interface for the table-driven OFDM error model
37 *
38 */
40{
41public:
46 static TypeId GetTypeId (void);
47
50
56 static std::optional<uint8_t> GetMcsForMode (WifiMode mode);
57
58
59private:
60 double DoGetChunkSuccessRate (WifiMode mode, const WifiTxVector& txVector, double snr, uint64_t nbits,
61 uint8_t numRxAntennas, WifiPpduField field, uint16_t staId) const override;
62
70 double RoundSnr (double snr, double precision) const;
71
80 double FetchFsr (WifiMode mode, const WifiTxVector& txVector, double snr, uint64_t nbits) const;
81
83
84 uint64_t m_threshold;
85};
86
87} //namespace ns3
88
89#endif /* TABLE_BASED_ERROR_RATE_MODEL_H */
the interface for Wifi's error models
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
Introspection did not find any typical Config paths.
Ptr< ErrorRateModel > m_fallbackErrorModel
Error rate model to fallback to if no value is found in the table.
static std::optional< uint8_t > GetMcsForMode(WifiMode mode)
Utility function to convert WifiMode to an MCS value.
double DoGetChunkSuccessRate(WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint8_t numRxAntennas, WifiPpduField field, uint16_t staId) const override
A pure virtual method that must be implemented in the subclass.
static TypeId GetTypeId(void)
Get the type ID.
double FetchFsr(WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits) const
Fetch the frame success rate for a given Wi-Fi mode, TXVECTOR, SNR and frame size.
double RoundSnr(double snr, double precision) const
Round SNR (in dB) to the specified precision.
uint64_t m_threshold
Threshold in bytes over which the table for large size frames is used.
a unique identifier for an interface.
Definition: type-id.h:59
represent a single transmission mode
Definition: wifi-mode.h:48
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
WifiPpduField
The type of PPDU field (grouped for convenience)
Every class exported by the ns3 library is enclosed in the ns3 namespace.