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 ()
 
virtual void SetupPhy (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 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 AddSupportedPlcpPreamble (Mac48Address address, bool isShortPreambleSupported)
 Record whether the short PLCP preamble is supported by the station. More...
 
WifiTxVector DoGetCtsToSelfTxVector (void)
 Since CTS-to-self parameters are not dependent on the station, it is implemented in wifiremote station manager. More...
 
WifiTxVector GetAckTxVector (Mac48Address address, WifiMode dataMode)
 
WifiMode GetBasicMcs (uint32_t i) const
 Return the MCS at the given list index. More...
 
WifiMode GetBasicMode (uint32_t i) const
 Return a basic mode from the set of basic modes. More...
 
WifiTxVector GetBlockAckTxVector (Mac48Address address, WifiMode dataMode)
 
WifiTxVector GetCtsToSelfTxVector (const WifiMacHeader *header, Ptr< const Packet > packet)
 
WifiTxVector GetCtsTxVector (Mac48Address address, WifiMode rtsMode)
 
WifiTxVector GetDataTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
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 (Mac48Address address) const
 Return whether the station supports Greenfield or not. More...
 
WifiRemoteStationInfo GetInfo (Mac48Address address)
 
uint32_t GetMaxSlrc (void) const
 Return the maximum STA long retry count (SLRC). More...
 
uint32_t GetMaxSsrc (void) const
 Return the maximum STA short retry count (SSRC). More...
 
uint32_t GetNBasicMcs (void) const
 Return the number of basic MCS index. More...
 
uint32_t GetNBasicModes (void) const
 Return the number of basic modes we support. More...
 
uint32_t GetNNonErpBasicModes (void) const
 Return the number of non-ERP basic modes we support. More...
 
WifiMode GetNonErpBasicMode (uint32_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...
 
uint32_t GetNumberOfTransmitAntennas (void)
 
ProtectionMode GetProtectionMode (void) const
 Return the protection mode. More...
 
uint32_t GetRtsCtsThreshold (void) const
 Return the RTS threshold. More...
 
WifiTxVector GetRtsTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool GetShortPreambleEnabled (void) const
 Return whether the device uses short PLCP preambles. More...
 
bool GetShortPreambleSupported (Mac48Address address) const
 Return whether the station supports short PLCP 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...
 
bool GetUseNonErpProtection (void) const
 Return whether the device supports protection of non-ERP stations. More...
 
bool HasHtSupported (void) const
 Return whether the device has HT capability support enabled. More...
 
bool HasVhtSupported (void) const
 Return whether the device has VHT capability support enabled. 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 NeedDataRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool NeedFragmentation (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool NeedRts (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, WifiTxVector txVector)
 
bool NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
void PrepareForQueue (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
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 ReportAmpduTxStatus (Mac48Address address, uint8_t tid, uint32_t nSuccessfulMpdus, uint32_t nFailedMpdus, double rxSnr, double dataSnr)
 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)
 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)
 Should be invoked whenever we receive the Ack associated to a data packet we just sent. More...
 
void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header)
 Should be invoked after calling ReportDataFailed if NeedDataRetransmission returns false. More...
 
void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header)
 Should be invoked after calling ReportRtsFailed if NeedRtsRetransmission 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, const WifiMacHeader *header, 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 Reset (Mac48Address address)
 Invoked in an AP upon disassociation of a specific STA. More...
 
void SetDefaultTxPowerLevel (uint8_t txPower)
 Set the default transmission power level. More...
 
void SetFragmentationThreshold (uint32_t threshold)
 Sets a fragmentation threshold. More...
 
virtual void SetHtSupported (bool enable)
 Enable or disable HT capability support. 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 SetProtectionMode (ProtectionMode mode)
 Sets the protection mode. More...
 
void SetRtsCtsThreshold (uint32_t threshold)
 Sets the RTS threshold. More...
 
void SetShortPreambleEnabled (bool enable)
 Enable or disable short PLCP preambles. More...
 
void SetShortSlotTimeEnabled (bool enable)
 Enable or disable short slot time. More...
 
virtual void SetupMac (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 SetUseNonErpProtection (bool enable)
 Enable or disable protection for non-ERP stations. More...
 
virtual void SetVhtSupported (bool enable)
 Enable or disable VHT capability support. More...
 
void UpdateFragmentationThreshold (void)
 Typically called to update the fragmentation threshold at the start of a new transmission. More...
 
- 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
 Implement the GetInstanceTypeId method defined in ObjectBase. 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...
 
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 ()
 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. 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)
 
- Static Public Member Functions inherited from ns3::WifiRemoteStationManager
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. 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...
 
virtual WifiRemoteStationDoCreateStation (void) const
 
virtual WifiTxVector DoGetDataTxVector (WifiRemoteStation *station)
 
virtual WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station)
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void DoReportAmpduTxStatus (WifiRemoteStation *station, uint32_t nSuccessfulMpdus, uint32_t nFailedMpdus, double rxSnr, double dataSnr)
 Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...
 
virtual void DoReportDataFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
virtual void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
virtual void DoReportFinalDataFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
virtual void DoReportFinalRtsFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
virtual void DoReportRtsFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
virtual 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...
 
virtual void DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
uint32_t GetChannelWidthForMode (WifiMode mode) const
 Convenience function for selecting a channel width for legacy mode. More...
 
double GetSnrThreshold (WifiTxVector txVector) const
 Return the minimum SNR needed to successfully transmit data with this WifiTxVector at the specified BER. More...
 
virtual bool IsLowLatency (void) const
 

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) (uint8_t power, Mac48Address remoteAddress)
 TracedCallback signature for power change events. More...
 
enum  ProtectionMode { RTS_CTS, CTS_TO_SELF }
 
typedef void(* RateChangeTracedCallback) (uint32_t rate, Mac48Address remoteAddress)
 TracedCallback signature for rate change events. More...
 
- Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void DoDispose (void)
 Destructor implementation. More...
 
bool GetAggregation (const WifiRemoteStation *station) const
 Return whether the given station supports A-MPDU. More...
 
uint32_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...
 
bool GetHtSupported (const WifiRemoteStation *station) const
 Return whether the given station is HT capable. More...
 
uint32_t GetLongRetryCount (const WifiRemoteStation *station) const
 Return the long retry limit of the given station. More...
 
Ptr< WifiMacGetMac (void) const
 Return the WifiMac. More...
 
WifiMode GetMcsSupported (const WifiRemoteStation *station, uint32_t i) const
 Return the WifiMode supported by the specified station at the specified index. More...
 
uint32_t GetNess (const WifiRemoteStation *station) const
 
uint32_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, uint32_t i) const
 Return whether non-ERP mode associated with the specified station at the specified index. More...
 
uint32_t GetNSupported (const WifiRemoteStation *station) const
 Return the number of modes supported by the given station. More...
 
uint8_t GetNumberOfSupportedRxAntennas (const WifiRemoteStation *station) const
 Return the number of receive antennas the station has. More...
 
Ptr< WifiPhyGetPhy (void) const
 Return the WifiPhy. More...
 
bool GetShortGuardInterval (const WifiRemoteStation *station) const
 Return whether the given station supports short guard interval. More...
 
uint32_t GetShortRetryCount (const WifiRemoteStation *station) const
 Return the short retry limit of the given station. More...
 
bool GetStbc (const WifiRemoteStation *station) const
 Return whether the given station supports space-time block coding (STBC). More...
 
WifiMode GetSupported (const WifiRemoteStation *station, uint32_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

  • IsLowLatency: If true, we attempt to modelize a so-called low-latency device: a device where decisions about tx parameters can be made on a per-packet basis and feedback about the transmission of each packet is obtained before sending the next. Otherwise, we modelize a high-latency device, that is a device where we cannot update our decision about tx parameters after every packet transmission.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Flags: read
  • MaxSsrc: The maximum number of retransmission attempts for an RTS. 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 read
  • MaxSlrc: The maximum number of retransmission attempts for a DATA packet. 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 read
  • 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 read
  • 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: 2346
    • 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
  • ProtectionMode: 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

TraceSources

  • Rate: Traced value for rate changes (b/s)
    Callback signature: ns3::TracedValueCallback::Uint64

TraceSources defined in parent class ns3::WifiRemoteStationManager

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

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

Member Typedef Documentation

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 105 of file ideal-wifi-manager.h.

Constructor & Destructor Documentation

ns3::IdealWifiManager::IdealWifiManager ( )

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

ns3::IdealWifiManager::~IdealWifiManager ( )
virtual

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

Member Function Documentation

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

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

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

Referenced by DoInitialize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

WifiRemoteStation * ns3::IdealWifiManager::DoCreateStation ( void  ) const
privatevirtual
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 258 of file ideal-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiRemoteStationManager::GetChannelWidth(), GetChannelWidthForMode(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDefaultMode(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetLongRetryCount(), ns3::WifiRemoteStationManager::GetMcsSupported(), ns3::WifiMode::GetMcsValue(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNMcsSupported(), ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetPhy(), GetSnrThreshold(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiPhy::GetSupportedTxSpatialStreams(), ns3::WifiMode::GetUniqueName(), ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::WifiRemoteStationManager::HasHtSupported(), ns3::WifiRemoteStationManager::HasVhtSupported(), ns3::WifiPhy::IsValidTxVector(), m_currentRate, ns3::IdealWifiRemoteStation::m_lastMode, ns3::IdealWifiRemoteStation::m_lastSnrCached, ns3::IdealWifiRemoteStation::m_lastSnrObserved, ns3::IdealWifiRemoteStation::m_nss, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetShortGuardInterval(), ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

+ Here is the call graph for this function:

WifiTxVector ns3::IdealWifiManager::DoGetRtsTxVector ( WifiRemoteStation station)
privatevirtual
void ns3::IdealWifiManager::DoReportAmpduTxStatus ( WifiRemoteStation station,
uint32_t  nSuccessfulMpdus,
uint32_t  nFailedMpdus,
double  rxSnr,
double  dataSnr 
)
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

Reimplemented from ns3::WifiRemoteStationManager.

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

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

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 206 of file ideal-wifi-manager.cc.

void ns3::IdealWifiManager::DoReportDataOk ( WifiRemoteStation station,
double  ackSnr,
WifiMode  ackMode,
double  dataSnr 
)
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

Implements ns3::WifiRemoteStationManager.

Definition at line 220 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:

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 253 of file ideal-wifi-manager.cc.

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 248 of file ideal-wifi-manager.cc.

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 201 of file ideal-wifi-manager.cc.

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 211 of file ideal-wifi-manager.cc.

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

+ Here is the call graph for this function:

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 195 of file ideal-wifi-manager.cc.

uint32_t ns3::IdealWifiManager::GetChannelWidthForMode ( WifiMode  mode) const
private

Convenience function for selecting a channel width for legacy mode.

Parameters
non-(V)HTWifiMode
Returns
the channel width (MHz) for the selected mode

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

double ns3::IdealWifiManager::GetSnrThreshold ( WifiTxVector  txVector) const
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

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

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetMode(), ns3::WifiTxVector::GetNss(), ns3::WifiMode::GetUniqueName(), ns3::WifiTxVector::IsShortGuardInterval(), m_thresholds, NS_ASSERT, NS_LOG_DEBUG, 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:

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

Definition at line 49 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:

bool ns3::IdealWifiManager::IsLowLatency ( void  ) const
privatevirtual
Returns
whether this manager is a manager designed to work in low-latency environments.

Note: In this context, low vs high latency is defined in IEEE 802.11 Rate Adaptation: A Practical Approach, by M. Lacage, M.H. Manshaei, and T. Turletti.

Implements ns3::WifiRemoteStationManager.

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

void ns3::IdealWifiManager::SetupPhy ( 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 78 of file ideal-wifi-manager.cc.

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

+ Here is the call graph for this function:

Member Data Documentation

double ns3::IdealWifiManager::m_ber
private

The maximum Bit Error Rate acceptable at any transmission mode.

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

Referenced by DoInitialize(), and GetTypeId().

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

Trace rate changes.

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

Referenced by DoGetDataTxVector(), and GetTypeId().

Thresholds ns3::IdealWifiManager::m_thresholds
private

List of WifiTxVector and the minimum SNR pair.

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

Referenced by AddSnrThreshold(), and GetSnrThreshold().


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