A Discrete-Event Network Simulator
API
ns3::IdealWifiManager Class Reference

Ideal rate control algorithmThis class implements an 'ideal' rate control algorithm similar to RBAR in spirit (see A rate-adaptive MAC protocol for multihop wireless networks by G. More...

#include "ideal-wifi-manager.h"

+ Inheritance diagram for ns3::IdealWifiManager:
+ Collaboration diagram for ns3::IdealWifiManager:

Public Member Functions

 IdealWifiManager ()
 
virtual ~IdealWifiManager ()
 
void SetupPhy (const Ptr< WifiPhy > phy)
 Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported. More...
 
- Public Member Functions inherited from ns3::WifiRemoteStationManager
 WifiRemoteStationManager ()
 
virtual ~WifiRemoteStationManager ()
 
void AddAllSupportedMcs (Mac48Address address)
 Invoked in a STA or AP to store all of the MCS supported by a destination which is also supported locally. More...
 
void AddAllSupportedModes (Mac48Address address)
 Invoked in a STA or AP to store all of the modes supported by a destination which is also supported locally. More...
 
void AddBasicMcs (WifiMode mcs)
 Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS. More...
 
void AddBasicMode (WifiMode mode)
 Invoked in a STA upon association to store the set of rates which belong to the BSSBasicRateSet of the associated AP and which are supported locally. More...
 
void AddStationHeCapabilities (Mac48Address from, HeCapabilities heCapabilities)
 Records HE capabilities of the remote station. More...
 
void AddStationHtCapabilities (Mac48Address from, HtCapabilities htCapabilities)
 Records HT capabilities of the remote station. More...
 
void AddStationVhtCapabilities (Mac48Address from, VhtCapabilities vhtCapabilities)
 Records VHT capabilities of the remote station. More...
 
void AddSupportedErpSlotTime (Mac48Address address, bool isShortSlotTimeSupported)
 Record whether the short ERP slot time is supported by the station. More...
 
void AddSupportedMcs (Mac48Address address, WifiMode mcs)
 Record the MCS index supported by the station. More...
 
void AddSupportedMode (Mac48Address address, WifiMode mode)
 Invoked in a STA or AP to store the set of modes supported by a destination which is also supported locally. More...
 
void AddSupportedPhyPreamble (Mac48Address address, bool isShortPreambleSupported)
 Record whether the short PHY preamble is supported by the station. More...
 
WifiMode GetBasicMcs (uint8_t i) const
 Return the MCS at the given list index. More...
 
WifiMode GetBasicMode (uint8_t i) const
 Return a basic mode from the set of basic modes. More...
 
uint16_t GetChannelWidthSupported (Mac48Address address) const
 Return the channel width supported by the station. More...
 
WifiTxVector GetCtsToSelfTxVector (void)
 Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote station manager. More...
 
WifiTxVector GetDataTxVector (const WifiMacHeader &header)
 
WifiMode GetDefaultMcs (void) const
 Return the default Modulation and Coding Scheme (MCS) index. More...
 
WifiMode GetDefaultMode (void) const
 Return the default transmission mode. More...
 
uint8_t GetDefaultTxPowerLevel (void) const
 
uint32_t GetFragmentationThreshold (void) const
 Return the fragmentation threshold. More...
 
uint32_t GetFragmentOffset (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
 
uint32_t GetFragmentSize (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
 
bool GetGreenfieldSupported (void) const
 Return whether the device has HT Greenfield support enabled. More...
 
bool GetGreenfieldSupported (Mac48Address address) const
 Return whether the station supports Greenfield or not. More...
 
uint16_t GetGuardInterval (void) const
 Return the supported HE guard interval duration (in nanoseconds). More...
 
bool GetHeSupported (void) const
 Return whether the device has HE capability support enabled. More...
 
bool GetHeSupported (Mac48Address address) const
 Return whether the station supports HE or not. More...
 
bool GetHtSupported (void) const
 Return whether the device has HT capability support enabled. More...
 
bool GetHtSupported (Mac48Address address) const
 Return whether the station supports HT or not. More...
 
WifiRemoteStationInfo GetInfo (Mac48Address address)
 
uint8_t GetMaxNumberOfTransmitStreams (void) const
 
uint8_t GetNBasicMcs (void) const
 Return the number of basic MCS index. More...
 
uint8_t GetNBasicModes (void) const
 Return the number of basic modes we support. More...
 
uint8_t GetNMcsSupported (Mac48Address address) const
 Return the number of MCS supported by the station. More...
 
uint32_t GetNNonErpBasicModes (void) const
 Return the number of non-ERP basic modes we support. More...
 
WifiMode GetNonErpBasicMode (uint8_t i) const
 Return a basic mode from the set of basic modes that is not an ERP mode. More...
 
WifiMode GetNonUnicastMode (void) const
 Return a mode for non-unicast packets. More...
 
uint8_t GetNumberOfAntennas (void) const
 
uint8_t GetNumberOfSupportedStreams (Mac48Address address) const
 Return the number of spatial streams supported by the station. More...
 
bool GetPcfSupported (void) const
 Return whether the device has PCF capability support enabled. More...
 
bool GetQosSupported (Mac48Address address) const
 Return whether the given station is QoS capable. More...
 
WifiTxVector GetRtsTxVector (Mac48Address address)
 
bool GetShortGuardIntervalSupported (void) const
 Return whether the device has SGI support enabled. More...
 
bool GetShortGuardIntervalSupported (Mac48Address address) const
 Return whether the station supports HT/VHT short guard interval. More...
 
bool GetShortPreambleEnabled (void) const
 Return whether the device uses short PHY preambles. More...
 
bool GetShortPreambleSupported (Mac48Address address) const
 Return whether the station supports short PHY preamble or not. More...
 
bool GetShortSlotTimeEnabled (void) const
 Return whether the device uses short slot time. More...
 
bool GetShortSlotTimeSupported (Mac48Address address) const
 Return whether the station supports short ERP slot time or not. More...
 
Ptr< const HeCapabilitiesGetStationHeCapabilities (Mac48Address from)
 Return the HE capabilities sent by the remote station. More...
 
Ptr< const HtCapabilitiesGetStationHtCapabilities (Mac48Address from)
 Return the HT capabilities sent by the remote station. More...
 
Ptr< const VhtCapabilitiesGetStationVhtCapabilities (Mac48Address from)
 Return the VHT capabilities sent by the remote station. More...
 
bool GetUseGreenfieldProtection (void) const
 Return whether protection for stations that do not support HT Greenfield format is enabled. More...
 
bool GetUseNonErpProtection (void) const
 Return whether the device supports protection of non-ERP stations. More...
 
bool GetUseNonHtProtection (void) const
 Return whether the device supports protection of non-HT stations. More...
 
bool GetVhtSupported (void) const
 Return whether the device has VHT capability support enabled. More...
 
bool GetVhtSupported (Mac48Address address) const
 Return whether the station supports VHT or not. More...
 
bool IsAssociated (Mac48Address address) const
 Return whether the station associated. More...
 
bool IsBrandNew (Mac48Address address) const
 Return whether the station state is brand new. More...
 
bool IsLastFragment (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
 
bool IsWaitAssocTxOk (Mac48Address address) const
 Return whether we are waiting for an ACK for the association response we sent. More...
 
bool NeedCtsToSelf (WifiTxVector txVector)
 Return if we need to do CTS-to-self before sending a DATA. More...
 
bool NeedFragmentation (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool NeedRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool NeedRts (const WifiMacHeader &header, uint32_t size)
 
void RecordDisassociated (Mac48Address address)
 Records that the STA was disassociated. More...
 
void RecordGotAssocTxFailed (Mac48Address address)
 Records that we missed an ACK for the association response we sent. More...
 
void RecordGotAssocTxOk (Mac48Address address)
 Records that we got an ACK for the association response we sent. More...
 
void RecordWaitAssocTxOk (Mac48Address address)
 Records that we are waiting for an ACK for the association response we sent. More...
 
void RemoveAllSupportedMcs (Mac48Address address)
 Invoked in a STA or AP to delete all of the supported MCS by a destination. More...
 
void ReportAmpduTxStatus (Mac48Address address, uint8_t nSuccessfulMpdus, uint8_t nFailedMpdus, double rxSnr, double dataSnr, WifiTxVector dataTxVector)
 Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...
 
void ReportDataFailed (Mac48Address address, const WifiMacHeader *header, uint32_t packetSize)
 Should be invoked whenever the AckTimeout associated to a transmission attempt expires. More...
 
void ReportDataOk (Mac48Address address, const WifiMacHeader *header, double ackSnr, WifiMode ackMode, double dataSnr, WifiTxVector dataTxVector, uint32_t packetSize)
 Should be invoked whenever we receive the ACK associated to a data packet we just sent. More...
 
void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header, uint32_t packetSize)
 Should be invoked after calling ReportDataFailed if NeedRetransmission returns false. More...
 
void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header)
 Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false. More...
 
void ReportRtsFailed (Mac48Address address, const WifiMacHeader *header)
 Should be invoked whenever the RtsTimeout associated to a transmission attempt expires. More...
 
void ReportRtsOk (Mac48Address address, const WifiMacHeader *header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
 Should be invoked whenever we receive the CTS associated to an RTS we just sent. More...
 
void ReportRxOk (Mac48Address address, double rxSnr, WifiMode txMode)
 
void Reset (void)
 Reset the station, invoked in a STA upon dis-association or in an AP upon reboot. More...
 
void SetDefaultTxPowerLevel (uint8_t txPower)
 Set the default transmission power level. More...
 
void SetFragmentationThreshold (uint32_t threshold)
 Sets a fragmentation threshold. More...
 
void SetMaxSlrc (uint32_t maxSlrc)
 Sets the maximum STA long retry count (SLRC). More...
 
void SetMaxSsrc (uint32_t maxSsrc)
 Sets the maximum STA short retry count (SSRC). More...
 
void SetPcfSupported (bool enable)
 Enable or disable PCF capability support. More...
 
void SetQosSupport (Mac48Address from, bool qosSupported)
 Records QoS support of the remote station. More...
 
void SetRtsCtsThreshold (uint32_t threshold)
 Sets the RTS threshold. More...
 
void SetShortPreambleEnabled (bool enable)
 Enable or disable short PHY preambles. More...
 
void SetShortSlotTimeEnabled (bool enable)
 Enable or disable short slot time. More...
 
virtual void SetupMac (const Ptr< WifiMac > mac)
 Set up MAC associated with this device since it is the object that knows the full set of timing parameters (e.g. More...
 
void SetUseGreenfieldProtection (bool enable)
 Enable or disable protection for stations that do not support HT Greenfield format. More...
 
void SetUseNonErpProtection (bool enable)
 Enable or disable protection for non-ERP stations. More...
 
void SetUseNonHtProtection (bool enable)
 Enable or disable protection for non-HT stations. More...
 
void UpdateFragmentationThreshold (void)
 Typically called to update the fragmentation threshold at the start of a new transmission. More...
 
bool UseGreenfieldForDestination (Mac48Address dest) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::WifiRemoteStationManager
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

typedef std::vector< std::pair< double, WifiTxVector > > Thresholds
 A vector of <snr, WifiTxVector> pair holding the minimum SNR for the WifiTxVector. More...
 

Private Member Functions

void AddSnrThreshold (WifiTxVector txVector, double snr)
 Adds a pair of WifiTxVector and the minimum SNR for that given vector to the list. More...
 
void BuildSnrThresholds (void)
 Construct the vector of minimum SNRs needed to successfully transmit for all possible combinations (rate, channel width, nss) based on PHY capabilities. More...
 
WifiRemoteStationDoCreateStation (void) const
 
WifiTxVector DoGetDataTxVector (WifiRemoteStation *station)
 
WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station)
 
void DoInitialize (void)
 Initialize() implementation. More...
 
void DoReportAmpduTxStatus (WifiRemoteStation *station, uint8_t nSuccessfulMpdus, uint8_t nFailedMpdus, double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)
 Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...
 
void DoReportDataFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportFinalDataFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportFinalRtsFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRtsFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRtsOk (WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
uint16_t GetChannelWidthForNonHtMode (WifiMode mode) const
 Convenience function for selecting a channel width for non-HT mode. More...
 
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 a given NSS. More...
 
double GetSnrThreshold (WifiTxVector txVector)
 Return the minimum SNR needed to successfully transmit data with this WifiTxVector at the specified BER. More...
 
void Reset (WifiRemoteStation *station) const
 Reset the station, invoked if the maximum amount of retries has failed. More...
 

Private Attributes

double m_ber
 The maximum Bit Error Rate acceptable at any transmission mode. More...
 
TracedValue< uint64_t > m_currentRate
 Trace rate changes. More...
 
Thresholds m_thresholds
 List of WifiTxVector and the minimum SNR pair. More...
 

Additional Inherited Members

- Public Types inherited from ns3::WifiRemoteStationManager
typedef void(* PowerChangeTracedCallback) (double oldPower, double newPower, Mac48Address remoteAddress)
 TracedCallback signature for power change events. More...
 
enum  ProtectionMode { RTS_CTS, CTS_TO_SELF }
 ProtectionMode enumeration. More...
 
typedef void(* RateChangeTracedCallback) (DataRate oldRate, DataRate newRate, Mac48Address remoteAddress)
 TracedCallback signature for rate change events. More...
 
typedef std::vector< WifiRemoteStation * > Stations
 A vector of WifiRemoteStations. More...
 
typedef std::vector< WifiRemoteStationState * > StationStates
 A vector of WifiRemoteStationStates. More...
 
- Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void DoDispose (void)
 Destructor implementation. More...
 
Mac48Address GetAddress (const WifiRemoteStation *station) const
 Return the address of the station. More...
 
bool GetAggregation (const WifiRemoteStation *station) const
 Return whether the given station supports A-MPDU. More...
 
uint16_t GetChannelWidth (const WifiRemoteStation *station) const
 Return the channel width supported by the station. More...
 
bool GetGreenfield (const WifiRemoteStation *station) const
 Return whether the station supports Greenfield or not. More...
 
uint16_t GetGuardInterval (const WifiRemoteStation *station) const
 Return the HE guard interval duration supported by the station. More...
 
bool GetHeSupported (const WifiRemoteStation *station) const
 Return whether the given station is HE capable. More...
 
bool GetHtSupported (const WifiRemoteStation *station) const
 Return whether the given station is HT capable. More...
 
Ptr< WifiMacGetMac (void) const
 Return the WifiMac. More...
 
WifiMode GetMcsSupported (const WifiRemoteStation *station, uint8_t i) const
 Return the WifiMode supported by the specified station at the specified index. More...
 
uint8_t GetNess (const WifiRemoteStation *station) const
 
uint8_t GetNMcsSupported (const WifiRemoteStation *station) const
 Return the number of MCS supported by the given station. More...
 
uint32_t GetNNonErpSupported (const WifiRemoteStation *station) const
 Return the number of non-ERP modes supported by the given station. More...
 
WifiMode GetNonErpSupported (const WifiRemoteStation *station, uint8_t i) const
 Return whether non-ERP mode associated with the specified station at the specified index. More...
 
uint8_t GetNSupported (const WifiRemoteStation *station) const
 Return the number of modes supported by the given station. More...
 
uint8_t GetNumberOfSupportedStreams (const WifiRemoteStation *station) const
 Return the number of supported streams the station has. More...
 
Ptr< WifiPhyGetPhy (void) const
 Return the WifiPhy. More...
 
bool GetQosSupported (const WifiRemoteStation *station) const
 Return whether the given station is QoS capable. More...
 
bool GetShortGuardIntervalSupported (const WifiRemoteStation *station) const
 Return whether the given station supports HT/VHT short guard interval. More...
 
WifiMode GetSupported (const WifiRemoteStation *station, uint8_t i) const
 Return whether mode associated with the specified station at the specified index. More...
 
bool GetVhtSupported (const WifiRemoteStation *station) const
 Return whether the given station is VHT capable. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Ideal rate control algorithm

This class implements an 'ideal' rate control algorithm similar to RBAR in spirit (see A rate-adaptive MAC protocol for multihop wireless networks by G.


Holland, N. Vaidya, and P. Bahl.): every station keeps track of the SNR of every packet received and sends back this SNR to the original transmitter by an out-of-band mechanism. Each transmitter keeps track of the last SNR sent back by a receiver and uses it to pick a transmission mode based on a set of SNR thresholds built from a target BER and transmission mode-specific SNR/BER curves.

Config Paths

ns3::IdealWifiManager is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManager/$ns3::IdealWifiManager"

Attributes

  • BerThreshold: The maximum Bit Error Rate acceptable at any transmission mode
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1e-05
    • Flags: construct write read

Attributes defined in parent class ns3::WifiRemoteStationManager

  • MaxSsrc: The maximum number of retransmission attempts for any packet with size <= RtsCtsThreshold. This value will not have any effect on some rate control algorithms.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 7
    • Flags: construct write
  • MaxSlrc: The maximum number of retransmission attempts for any packet with size > RtsCtsThreshold. This value will not have any effect on some rate control algorithms.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 4
    • Flags: construct write
  • RtsCtsThreshold: If the size of the PSDU is bigger than this value, we use an RTS/CTS handshake before sending the data frame.This value will not have any effect on some rate control algorithms.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 65535
    • Flags: construct write
  • FragmentationThreshold: If the size of the PSDU is bigger than this value, we fragment it such that the size of the fragments are equal or smaller. This value does not apply when it is carried in an A-MPDU. This value will not have any effect on some rate control algorithms.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 65535
    • Flags: construct write read
  • NonUnicastMode: Wifi mode used for non-unicast transmissions.
    • Set with class: WifiModeValue
    • Underlying type: WifiMode
    • Initial value: Invalid-WifiMode
    • Flags: construct write read
  • DefaultTxPowerLevel: Default power level to be used for transmissions. This is the power level that is used by all those WifiManagers that do not implement TX power control.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: construct write read
  • ErpProtectionMode: Protection mode used when non-ERP STAs are connected to an ERP AP: Rts-Cts or Cts-To-Self
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: Cts-To-Self
    • Flags: construct write read
  • HtProtectionMode: Protection mode used when non-HT STAs are connected to a HT AP: Rts-Cts or Cts-To-Self
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: Cts-To-Self
    • Flags: construct write read

TraceSources

TraceSources defined in parent class ns3::WifiRemoteStationManager

Size of this type is 352 bytes (on a 64-bit architecture).

Definition at line 46 of file ideal-wifi-manager.h.

Member Typedef Documentation

◆ Thresholds

typedef std::vector<std::pair<double, WifiTxVector> > ns3::IdealWifiManager::Thresholds
private

A vector of <snr, WifiTxVector> pair holding the minimum SNR for the WifiTxVector.

Definition at line 132 of file ideal-wifi-manager.h.

Constructor & Destructor Documentation

◆ IdealWifiManager()

ns3::IdealWifiManager::IdealWifiManager ( )

Definition at line 72 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ ~IdealWifiManager()

ns3::IdealWifiManager::~IdealWifiManager ( )
virtual

Definition at line 78 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddSnrThreshold()

void ns3::IdealWifiManager::AddSnrThreshold ( WifiTxVector  txVector,
double  snr 
)
private

Adds a pair of WifiTxVector and the minimum SNR for that given vector to the list.

Parameters
txVectorthe WifiTxVector storing mode, channel width, and Nss
snrthe minimum SNR for the given txVector in linear scale

Definition at line 214 of file ideal-wifi-manager.cc.

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetUniqueName(), m_thresholds, and NS_LOG_FUNCTION.

Referenced by BuildSnrThresholds().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BuildSnrThresholds()

◆ DoCreateStation()

WifiRemoteStation * ns3::IdealWifiManager::DoCreateStation ( void  ) const
privatevirtual
Returns
a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 221 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION, and ns3::WifiRemoteStationManager::Reset().

+ Here is the call graph for this function:

◆ DoGetDataTxVector()

WifiTxVector ns3::IdealWifiManager::DoGetDataTxVector ( WifiRemoteStation station)
privatevirtual
Parameters
stationthe station that we need to communicate
Returns
the TXVECTOR to use to send a packet to the station

Note: This method is called before sending a unicast packet or a fragment of a unicast packet to decide which transmission mode to use.

Implements ns3::WifiRemoteStationManager.

Definition at line 319 of file ideal-wifi-manager.cc.

References ns3::CACHE_INITIAL_VALUE, ns3::WifiRemoteStationManager::GetAddress(), ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiRemoteStationManager::GetChannelWidth(), GetChannelWidthForNonHtMode(), ns3::GetChannelWidthForTransmission(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDefaultMode(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiTxVector::GetGuardInterval(), ns3::WifiRemoteStationManager::GetGuardInterval(), ns3::WifiRemoteStationManager::GetHeSupported(), ns3::WifiRemoteStationManager::GetHtSupported(), GetLastObservedSnr(), ns3::WifiRemoteStationManager::GetMaxNumberOfTransmitStreams(), ns3::WifiRemoteStationManager::GetMcsSupported(), ns3::WifiMode::GetMcsValue(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNMcsSupported(), ns3::WifiTxVector::GetNss(), ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetNumberOfAntennas(), ns3::WifiRemoteStationManager::GetNumberOfSupportedStreams(), ns3::WifiRemoteStationManager::GetPhy(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), GetSnrThreshold(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiMode::GetUniqueName(), ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::WifiTxVector::IsValid(), m_currentRate, ns3::IdealWifiRemoteStation::m_lastChannelWidth, ns3::IdealWifiRemoteStation::m_lastMode, ns3::IdealWifiRemoteStation::m_lastNss, ns3::IdealWifiRemoteStation::m_lastSnrCached, ns3::IdealWifiRemoteStation::m_lastSnrObserved, max, min, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiRemoteStationManager::UseGreenfieldForDestination(), ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

+ Here is the call graph for this function:

◆ DoGetRtsTxVector()

◆ DoInitialize()

void ns3::IdealWifiManager::DoInitialize ( void  )
privatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 108 of file ideal-wifi-manager.cc.

References BuildSnrThresholds(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoReportAmpduTxStatus()

void ns3::IdealWifiManager::DoReportAmpduTxStatus ( WifiRemoteStation station,
uint8_t  nSuccessfulMpdus,
uint8_t  nFailedMpdus,
double  rxSnr,
double  dataSnr,
uint16_t  dataChannelWidth,
uint8_t  dataNss 
)
privatevirtual

Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed.

This method is a virtual method that must be implemented by the sub-class intended to handle A-MPDUs. This allows different types of WifiRemoteStationManager to respond differently.

Parameters
stationthe station that sent the DATA to us
nSuccessfulMpdusnumber of successfully transmitted MPDUs. A value of 0 means that the Block ACK was missed.
nFailedMpdusnumber of unsuccessfully transmitted MPDUs.
rxSnrreceived SNR of the block ack frame itself
dataSnrdata SNR reported by remote station
dataChannelWidththe channel width (in MHz) of the A-MPDU we sent
dataNssthe number of spatial streams used to send the A-MPDU

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 289 of file ideal-wifi-manager.cc.

References ns3::IdealWifiRemoteStation::m_lastChannelWidthObserved, ns3::IdealWifiRemoteStation::m_lastNssObserved, ns3::IdealWifiRemoteStation::m_lastSnrObserved, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportDataFailed()

void ns3::IdealWifiManager::DoReportDataFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 256 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportDataOk()

void ns3::IdealWifiManager::DoReportDataOk ( WifiRemoteStation station,
double  ackSnr,
WifiMode  ackMode,
double  dataSnr,
uint16_t  dataChannelWidth,
uint8_t  dataNss 
)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we successfully sent RTS
ackSnrthe SNR of the ACK we received
ackModethe WifiMode the receiver used to send the ACK
dataSnrthe SNR of the DATA we sent
dataChannelWidththe channel width (in MHz) of the DATA we sent
dataNssthe number of spatial streams used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 273 of file ideal-wifi-manager.cc.

References ns3::WifiMode::GetUniqueName(), NS_LOG_FUNCTION, and NS_LOG_WARN.

+ Here is the call graph for this function:

◆ DoReportFinalDataFailed()

void ns3::IdealWifiManager::DoReportFinalDataFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 312 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION, and ns3::WifiRemoteStationManager::Reset().

+ Here is the call graph for this function:

◆ DoReportFinalRtsFailed()

void ns3::IdealWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 305 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION, and ns3::WifiRemoteStationManager::Reset().

+ Here is the call graph for this function:

◆ DoReportRtsFailed()

void ns3::IdealWifiManager::DoReportRtsFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 250 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsOk()

void ns3::IdealWifiManager::DoReportRtsOk ( WifiRemoteStation station,
double  ctsSnr,
WifiMode  ctsMode,
double  rtsSnr 
)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we successfully sent RTS
ctsSnrthe SNR of the CTS we received
ctsModethe WifiMode the receiver used to send the CTS
rtsSnrthe SNR of the RTS we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 262 of file ideal-wifi-manager.cc.

References ns3::WifiPhy::GetChannelWidth(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiMode::GetUniqueName(), ns3::IdealWifiRemoteStation::m_lastSnrObserved, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoReportRxOk()

void ns3::IdealWifiManager::DoReportRxOk ( WifiRemoteStation station,
double  rxSnr,
WifiMode  txMode 
)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that sent the DATA to us
rxSnrthe SNR of the DATA we received
txModethe WifiMode the sender used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 244 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ GetChannelWidthForNonHtMode()

uint16_t ns3::IdealWifiManager::GetChannelWidthForNonHtMode ( WifiMode  mode) const
private

Convenience function for selecting a channel width for non-HT mode.

Parameters
modenon-HT WifiMode
Returns
the channel width (MHz) for the selected mode

Definition at line 91 of file ideal-wifi-manager.cc.

References ns3::WifiMode::GetModulationClass(), NS_ASSERT, ns3::WIFI_MOD_CLASS_DSSS, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HR_DSSS, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Referenced by BuildSnrThresholds(), DoGetDataTxVector(), and DoGetRtsTxVector().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetLastObservedSnr()

double ns3::IdealWifiManager::GetLastObservedSnr ( IdealWifiRemoteStation station,
uint16_t  channelWidth,
uint8_t  nss 
) const
private

Convenience function to get the last observed SNR from a given station for a given channel width and a given NSS.

Since the previously received SNR information might be related to a different channel width than the requested one, and/or a different NSS, the function does some computations to get the corresponding SNR.

Parameters
stationthe station being queried
channelWidththe channel width (in MHz)
nssthe number of spatial streams
Returns
the SNR in linear scale

Definition at line 571 of file ideal-wifi-manager.cc.

References ns3::IdealWifiRemoteStation::m_lastChannelWidthObserved, ns3::IdealWifiRemoteStation::m_lastNssObserved, ns3::IdealWifiRemoteStation::m_lastSnrObserved, and NS_LOG_DEBUG.

Referenced by DoGetDataTxVector().

+ Here is the caller graph for this function:

◆ GetSnrThreshold()

double ns3::IdealWifiManager::GetSnrThreshold ( WifiTxVector  txVector)
private

Return the minimum SNR needed to successfully transmit data with this WifiTxVector at the specified BER.

Parameters
txVectorWifiTxVector (containing valid mode, width, and Nss)
Returns
the minimum SNR for the given WifiTxVector in linear scale

Definition at line 191 of file ideal-wifi-manager.cc.

References BuildSnrThresholds(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetMode(), ns3::WifiTxVector::GetNss(), m_thresholds, NS_ASSERT_MSG(), and NS_LOG_FUNCTION.

Referenced by DoGetDataTxVector(), and DoGetRtsTxVector().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::IdealWifiManager::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 53 of file ideal-wifi-manager.cc.

References m_ber, m_currentRate, ns3::MakeDoubleAccessor(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Reset()

◆ SetupPhy()

void ns3::IdealWifiManager::SetupPhy ( const Ptr< WifiPhy phy)
virtual

Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported.

Parameters
phythe PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 84 of file ideal-wifi-manager.cc.

References NS_LOG_FUNCTION, third::phy, and ns3::WifiRemoteStationManager::SetupPhy().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_ber

double ns3::IdealWifiManager::m_ber
private

The maximum Bit Error Rate acceptable at any transmission mode.

Definition at line 134 of file ideal-wifi-manager.h.

Referenced by BuildSnrThresholds(), and GetTypeId().

◆ m_currentRate

TracedValue<uint64_t> ns3::IdealWifiManager::m_currentRate
private

Trace rate changes.

Definition at line 137 of file ideal-wifi-manager.h.

Referenced by DoGetDataTxVector(), and GetTypeId().

◆ m_thresholds

Thresholds ns3::IdealWifiManager::m_thresholds
private

List of WifiTxVector and the minimum SNR pair.

Definition at line 135 of file ideal-wifi-manager.h.

Referenced by AddSnrThreshold(), BuildSnrThresholds(), and GetSnrThreshold().


The documentation for this class was generated from the following files: