A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::IdealWifiManager Class Reference
Wifi Models

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. 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. 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)
- Public Member Functions inherited from ns3::WifiRemoteStationManager
 WifiRemoteStationManager ()
virtual ~WifiRemoteStationManager ()
void AddBasicMode (WifiMode mode)
void AddSupportedMode (Mac48Address address, WifiMode mode)
WifiMode GetAckMode (Mac48Address address, WifiMode dataMode)
WifiMode GetBasicMode (uint32_t i) const
WifiMode GetCtsMode (Mac48Address address, WifiMode rtsMode)
WifiMode GetDataMode (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fullPacketSize)
WifiMode GetDefaultMode (void) const
uint32_t GetFragmentationThreshold (void) const
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)
WifiRemoteStationInfo GetInfo (Mac48Address address)
uint32_t GetMaxSlrc (void) const
uint32_t GetMaxSsrc (void) const
uint32_t GetNBasicModes (void) const
WifiMode GetNonUnicastMode (void) const
uint32_t GetRtsCtsThreshold (void) const
WifiMode GetRtsMode (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
bool IsAssociated (Mac48Address address) const
bool IsBrandNew (Mac48Address address) const
bool IsLastFragment (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
bool IsWaitAssocTxOk (Mac48Address address) const
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)
bool NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
void PrepareForQueue (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fullPacketSize)
void RecordDisassociated (Mac48Address address)
void RecordGotAssocTxFailed (Mac48Address address)
void RecordGotAssocTxOk (Mac48Address address)
void RecordWaitAssocTxOk (Mac48Address address)
void ReportDataFailed (Mac48Address address, const WifiMacHeader *header)
void ReportDataOk (Mac48Address address, const WifiMacHeader *header, double ackSnr, WifiMode ackMode, double dataSnr)
void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header)
void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header)
void ReportRtsFailed (Mac48Address address, const WifiMacHeader *header)
void ReportRtsOk (Mac48Address address, const WifiMacHeader *header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
void ReportRxOk (Mac48Address address, const WifiMacHeader *header, double rxSnr, WifiMode txMode)
void Reset (void)
void Reset (Mac48Address address)
void SetFragmentationThreshold (uint32_t threshold)
void SetMaxSlrc (uint32_t maxSlrc)
void SetMaxSsrc (uint32_t maxSsrc)
void SetRtsCtsThreshold (uint32_t threshold)
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Initialize (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)

Private Types

typedef std::vector< std::pair
< double, WifiMode > > 		Thresholds

Private Member Functions

void AddModeSnrThreshold (WifiMode mode, double ber)
virtual WifiRemoteStation * DoCreateStation (void) const
virtual WifiMode DoGetDataMode (WifiRemoteStation *station, uint32_t size)
virtual WifiMode DoGetRtsMode (WifiRemoteStation *station)
virtual void DoReportDataFailed (WifiRemoteStation *station)
virtual void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr)
virtual void DoReportFinalDataFailed (WifiRemoteStation *station)
virtual void DoReportFinalRtsFailed (WifiRemoteStation *station)
virtual void DoReportRtsFailed (WifiRemoteStation *station)
virtual void DoReportRtsOk (WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)
virtual void DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode)
double GetSnrThreshold (WifiMode mode) const
virtual bool IsLowLatency (void) const

Private Attributes

double m_ber
double m_maxSnr
double m_minSnr
Thresholds m_thresholds

Additional Inherited Members

- Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void DoDispose (void)
uint32_t GetNSupported (const WifiRemoteStation *station) const
WifiMode GetSupported (const WifiRemoteStation *station, uint32_t i) const

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.
  • MaxSsrc: The maximum number of retransmission attempts for an RTS. This value will not have any effect on some rate control algorithms.
  • MaxSlrc: The maximum number of retransmission attempts for a DATA packet. This value will not have any effect on some rate control algorithms.
  • RtsCtsThreshold: If the size of the data packet + LLC header + MAC header + FCS trailer is bigger than this value, we use an RTS/CTS handshake before sending the data, as per IEEE Std. 802.11-2007, Section 9.2.6. This value will not have any effect on some rate control algorithms.
  • FragmentationThreshold: If the size of the data packet + LLC header + MAC header + FCS trailer is biggerthan this value, we fragment it such that the size of the fragments are equal or smaller than this value, as per IEEE Std. 802.11-2007, Section 9.4. This value will not have any effect on some rate control algorithms.
  • NonUnicastMode: Wifi mode used for non-unicast transmissions.
    • Set with class: WifiModeValue
    • Underlying type: WifiMode
    • Initial value: Invalid-WifiMode
    • Flags: construct write read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::WifiRemoteStationManager

  • MacTxRtsFailed: The transmission of a RTS by the MAC layer has failed
  • MacTxDataFailed: The transmission of a data packet by the MAC layer has failed
  • MacTxFinalRtsFailed: The transmission of a RTS has exceeded the maximum number of attempts
  • MacTxFinalDataFailed: The transmission of a data packet has exceeded the maximum number of attempts

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

Member Typedef Documentation

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

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

Constructor & Destructor Documentation

ns3::IdealWifiManager::IdealWifiManager ( )

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

ns3::IdealWifiManager::~IdealWifiManager ( )
virtual

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

Member Function Documentation

void ns3::IdealWifiManager::AddModeSnrThreshold ( WifiMode  mode,
double  ber 
)
private

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

References m_thresholds.

Referenced by SetupPhy().

+ Here is the caller graph for this function:

WifiRemoteStation * ns3::IdealWifiManager::DoCreateStation ( void  ) const
privatevirtual

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

References ns3::IdealWifiRemoteStation::m_lastSnr.

WifiMode ns3::IdealWifiManager::DoGetDataMode ( WifiRemoteStation *  station,
uint32_t  size 
)
privatevirtual

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

References ns3::WifiRemoteStationManager::GetDefaultMode(), ns3::WifiRemoteStationManager::GetNSupported(), GetSnrThreshold(), and ns3::WifiRemoteStationManager::GetSupported().

+ Here is the call graph for this function:

WifiMode ns3::IdealWifiManager::DoGetRtsMode ( WifiRemoteStation *  station)
privatevirtual

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

References ns3::WifiRemoteStationManager::GetBasicMode(), ns3::WifiRemoteStationManager::GetDefaultMode(), ns3::WifiRemoteStationManager::GetNBasicModes(), and GetSnrThreshold().

+ Here is the call graph for this function:

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

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

void ns3::IdealWifiManager::DoReportDataOk ( WifiRemoteStation *  station,
double  ackSnr,
WifiMode  ackMode,
double  dataSnr 
)
privatevirtual

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

References ns3::IdealWifiRemoteStation::m_lastSnr.

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

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

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

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

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

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

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

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

References ns3::IdealWifiRemoteStation::m_lastSnr.

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

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

double ns3::IdealWifiManager::GetSnrThreshold ( WifiMode  mode) const
private

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

References m_thresholds, and NS_ASSERT.

Referenced by DoGetDataMode(), and DoGetRtsMode().

+ Here is the caller graph for this function:

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

Reimplemented from ns3::WifiRemoteStationManager.

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

References m_ber, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

bool ns3::IdealWifiManager::IsLowLatency ( void  ) const
privatevirtual

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

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

Reimplemented from ns3::WifiRemoteStationManager.

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

References AddModeSnrThreshold(), ns3::WifiPhy::CalculateSnr(), ns3::WifiPhy::GetMode(), ns3::WifiPhy::GetNModes(), and m_ber.

+ Here is the call graph for this function:

Member Data Documentation

double ns3::IdealWifiManager::m_ber
private

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

Referenced by GetTypeId(), and SetupPhy().

double ns3::IdealWifiManager::m_maxSnr
private

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

double ns3::IdealWifiManager::m_minSnr
private

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

Thresholds ns3::IdealWifiManager::m_thresholds
private

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

Referenced by AddModeSnrThreshold(), and GetSnrThreshold().

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