A Discrete-Event Network Simulator
API
ideal-wifi-manager.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef IDEAL_WIFI_MANAGER_H
22 #define IDEAL_WIFI_MANAGER_H
23 
24 #include "ns3/traced-value.h"
25 #include "ns3/wifi-remote-station-manager.h"
26 
27 namespace ns3 {
28 
29 struct IdealWifiRemoteStation;
30 
47 {
48 public:
53  static TypeId GetTypeId (void);
55  virtual ~IdealWifiManager ();
56 
57  void SetupPhy (const Ptr<WifiPhy> phy) override;
58 
59 
60 private:
61  void DoInitialize (void) override;
62  WifiRemoteStation* DoCreateStation (void) const override;
63  void DoReportRxOk (WifiRemoteStation *station,
64  double rxSnr, WifiMode txMode) override;
65  void DoReportRtsFailed (WifiRemoteStation *station) override;
66  void DoReportDataFailed (WifiRemoteStation *station) override;
67  void DoReportRtsOk (WifiRemoteStation *station,
68  double ctsSnr, WifiMode ctsMode, double rtsSnr) override;
69  void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode,
70  double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override;
71  void DoReportAmpduTxStatus (WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus,
72  double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override;
73  void DoReportFinalRtsFailed (WifiRemoteStation *station) override;
74  void DoReportFinalDataFailed (WifiRemoteStation *station) override;
77 
83  void Reset (WifiRemoteStation *station) const;
84 
90  void BuildSnrThresholds (void);
91 
100  double GetSnrThreshold (WifiTxVector txVector);
108  void AddSnrThreshold (WifiTxVector txVector, double snr);
109 
115  uint16_t GetChannelWidthForNonHtMode (WifiMode mode) const;
116 
127  double GetLastObservedSnr (IdealWifiRemoteStation *station, uint16_t channelWidth, uint8_t nss) const;
128 
133  typedef std::vector<std::pair<double, WifiTxVector> > Thresholds;
134 
135  double m_ber;
137 
139 };
140 
141 } //namespace ns3
142 
143 #endif /* IDEAL_WIFI_MANAGER_H */
Ideal rate control algorithm.
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void AddSnrThreshold(WifiTxVector txVector, double snr)
Adds a pair of WifiTxVector and the minimum SNR for that given vector to the list.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
uint16_t GetChannelWidthForNonHtMode(WifiMode mode) const
Convenience function for selecting a channel width for non-HT mode.
double m_ber
The maximum Bit Error Rate acceptable at any transmission mode.
void DoReportRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoInitialize(void) override
Initialize() implementation.
void BuildSnrThresholds(void)
Construct the vector of minimum SNRs needed to successfully transmit for all possible combinations (r...
static TypeId GetTypeId(void)
Get the type ID.
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station) override
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportAmpduTxStatus(WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override
Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTime...
void SetupPhy(const Ptr< WifiPhy > phy) override
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
TracedValue< uint64_t > m_currentRate
Trace rate changes.
double GetLastObservedSnr(IdealWifiRemoteStation *station, uint16_t channelWidth, uint8_t nss) const
Convenience function to get the last observed SNR from a given station for a given channel width and ...
void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr) override
This method is a pure virtual method that must be implemented by the sub-class.
Thresholds m_thresholds
List of WifiTxVector and the minimum SNR pair.
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
This method is a pure virtual method that must be implemented by the sub-class.
std::vector< std::pair< double, WifiTxVector > > Thresholds
A vector of <snr, WifiTxVector> pair holding the minimum SNR for the WifiTxVector.
double GetSnrThreshold(WifiTxVector txVector)
Return the minimum SNR needed to successfully transmit data with this WifiTxVector at the specified B...
WifiRemoteStation * DoCreateStation(void) const override
void DoReportDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
a unique identifier for an interface.
Definition: type-id.h:59
represent a single transmission mode
Definition: wifi-mode.h:48
hold a list of per-remote-station state.
void Reset(void)
Reset the station, invoked in a STA upon dis-association or in an AP upon reboot.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:93
hold per-remote-station state for Ideal Wifi manager.
hold per-remote-station state.