wifi: Fix RAAs documentation that was relying on removed attributes

This commit is contained in:
Sebastien Deronne
2019-12-30 15:12:58 +01:00
committed by Sébastien Deronne
parent e57ff03c10
commit eaf27c8a73
12 changed files with 29 additions and 22 deletions

View File

@@ -35,9 +35,9 @@ namespace ns3 {
* A Practical Approach</i>, by M. Lacage, M.H. Manshaei, and
* T. Turletti.
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class AarfWifiManager : public WifiRemoteStationManager
{

View File

@@ -37,9 +37,9 @@ struct AarfcdWifiRemoteStation;
* version of ns-3. Federico died before merging this work in ns-3 itself so his code was ported
* to ns-3 later without his supervision.
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class AarfcdWifiManager : public WifiRemoteStationManager
{

View File

@@ -37,9 +37,9 @@ struct AmrrWifiRemoteStation;
* A Practical Approach</i>, by M. Lacage, M.H. Manshaei, and
* T. Turletti.
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class AmrrWifiManager : public WifiRemoteStationManager
{

View File

@@ -38,9 +38,9 @@ struct AparfWifiRemoteStation;
* Networks, Springer, 2005, 12, 123-145.
* http://www.cs.mun.ca/~yzchen/papers/papers/rate_adaptation/80211_dynamic_rate_power_adjustment_chevillat_j2005.pdf
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class AparfWifiManager : public WifiRemoteStationManager
{

View File

@@ -41,9 +41,9 @@ namespace ns3 {
* the time-based timer could be easily replaced with a packet-based
* timer.)
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class ArfWifiManager : public WifiRemoteStationManager
{

View File

@@ -37,9 +37,9 @@ namespace ns3 {
* Originally implemented by Federico Maguolo for a very early
* prototype version of ns-3.
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class CaraWifiManager : public WifiRemoteStationManager
{

View File

@@ -178,8 +178,12 @@ static const uint8_t MAX_VHT_WIDTH = 160; //!< Maximal channel width.
* each interval. However, it samples less often the low rates and high
* probability of error rates.
*
* When this rate control is configured but HT and VHT are not supported,
* When this rate control is configured but non-legacy modes are not supported,
* Minstrel-HT uses legacy Minstrel (minstrel-wifi-manager) for rate control.
*
* This RAA does not support HE modes yet and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that supports 802.11ax or higher.
*/
class MinstrelHtWifiManager : public WifiRemoteStationManager
{

View File

@@ -124,10 +124,10 @@ struct MinstrelWifiRemoteStation : public WifiRemoteStation
* that it considers successful, and spends a fraction of its time
* doing 'look around' by trying other rates.
*
* Minstrel is appropriate for non-HT/VHT/HE configurations; for HT/VHT/HE
* (i.e. 802.11n/ac/ax), users should use MinstrelHtWifiManager instead.
* Minstrel is appropriate for nlegacy configurations; for non-legacy
* (i.e. 802.11n or higher), users should use MinstrelHtWifiManager instead.
* Minstrel will error exit if the user tries to configure it with a
* Wi-Fi MAC that has VhtSupported, HtSupported or HeSupported set.
* Wi-Fi MAC that supports 802.11n or higher.
*
* Some notes on this implementation follow. The implementation has
* been adapted to bring it closer to the Linux implementation.

View File

@@ -39,9 +39,9 @@ struct OnoeWifiRemoteStation;
* any publication or reference about this algorithm beyond the madwifi
* source code.
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class OnoeWifiManager : public WifiRemoteStationManager
{

View File

@@ -36,9 +36,9 @@ struct ParfWifiRemoteStation;
* Wireless Networks, Kluwer Academic Publishers, 2007, 13, 737-755
* http://www.cs.odu.edu/~nadeem/classes/cs795-WNS-S13/papers/enter-006.pdf
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class ParfWifiManager : public WifiRemoteStationManager
{

View File

@@ -51,9 +51,9 @@ typedef std::vector<std::pair<WifiRraaThresholds, WifiMode> > RraaThresholdsTabl
* by "Starsky H. Y. Wong", "Hao Yang", "Songwu Lu", and,
* "Vaduvur Bharghavan" published in Mobicom 06.
*
* This RAA does not support HT, VHT nor HE modes and will error
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
* that supports 802.11n or higher.
*/
class RraaWifiManager : public WifiRemoteStationManager
{

View File

@@ -45,6 +45,9 @@ struct RrpaaWifiRemoteStation;
* international conference on Mobile computing and networking (pp. 146-157). ACM.
* http://ocw.cs.pub.ro/courses/_media/isrm/articole/rrate_adapt_mobicom06.pdf
*
* This RAA does not support non-legacy modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that supports 802.11n or higher.
*/
/**