APARF Power and rate control algorithm. More...

#include "aparf-wifi-manager.h"

Inheritance diagram for ns3::AparfWifiManager:

Collaboration diagram for ns3::AparfWifiManager:

Public Types
enum	State { High , Low , Spread }
	Enumeration of the possible states of the channel. More...

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...

using	Stations = std::unordered_map< Mac48Address, WifiRemoteStation *, WifiAddressHash >
	A map of WifiRemoteStations with Mac48Address as key. More...

using	StationStates = std::unordered_map< Mac48Address, WifiRemoteStationState *, WifiAddressHash >
	A map of WifiRemoteStationStates with Mac48Address as key. More...

Public Member Functions
	AparfWifiManager ()

virtual	~AparfWifiManager ()

void	SetupPhy (const Ptr< WifiPhy > phy) override
	Set up PHY associated with this device since it is the object that knows the full set of transmit 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...

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

WifiTxVector	GetAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
	Return a TXVECTOR for the Ack frame given the destination and the mode of the Data used by the sender. More...

uint16_t	GetAssociationId (Mac48Address remoteAddress) const
	Get the AID of a remote 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...

WifiTxVector	GetBlockAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
	Return a TXVECTOR for the BlockAck frame given the destination and the mode of the Data used by the sender. More...

uint16_t	GetChannelWidthSupported (Mac48Address address) const
	Return the channel width supported by the station. More...

WifiMode	GetControlAnswerMode (WifiMode reqMode) const
	Get control answer mode function. 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	GetCtsTxVector (Mac48Address to, WifiMode rtsTxMode) const
	Return a TXVECTOR for the CTS frame given the destination and the mode of the RTS used by the sender. 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...

WifiMode	GetDefaultModeForSta (const WifiRemoteStation *st) const
	Return the default MCS to use to transmit frames to the given station. More...

uint8_t	GetDefaultTxPowerLevel (void) const

bool	GetDsssSupported (const Mac48Address &address) const
	Return whether the station supports DSSS or not. More...

bool	GetErpOfdmSupported (const Mac48Address &address) const
	Return whether the station supports ERP OFDM or not. More...

uint32_t	GetFragmentationThreshold (void) const
	Return the fragmentation threshold. More...

uint32_t	GetFragmentOffset (Ptr< const WifiMacQueueItem > mpdu, uint32_t fragmentNumber)

uint32_t	GetFragmentSize (Ptr< const WifiMacQueueItem > mpdu, uint32_t fragmentNumber)

uint16_t	GetGuardInterval (void) const
	Return the supported HE guard interval duration (in nanoseconds). More...

bool	GetHeSupported (Mac48Address address) const
	Return whether the station supports HE or not. More...

bool	GetHeSupported (void) const
	Return whether the device has HE capability support enabled. More...

bool	GetHtSupported (Mac48Address address) const
	Return whether the station supports HT or not. More...

bool	GetHtSupported (void) const
	Return whether the device has HT capability support enabled. More...

WifiRemoteStationInfo	GetInfo (Mac48Address address)

bool	GetLdpcSupported (Mac48Address address) const
	Return whether the station supports LDPC or not. More...

bool	GetLdpcSupported (void) const
	Return whether the device has LDPC support enabled. More...

Ptr< WifiMac >	GetMac (void) const
	Return the WifiMac. More...

uint8_t	GetMaxNumberOfTransmitStreams (void) const

double	GetMostRecentRssi (Mac48Address address) 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	GetOfdmSupported (const Mac48Address &address) const
	Return whether the station supports OFDM or not. More...

Ptr< WifiPhy >	GetPhy (void) const
	Return the WifiPhy. More...

bool	GetQosSupported (Mac48Address address) const
	Return whether the given station is QoS capable. More...

WifiTxVector	GetRtsTxVector (Mac48Address address)

bool	GetShortGuardIntervalSupported (Mac48Address address) const
	Return whether the station supports HT/VHT short guard interval. More...

bool	GetShortGuardIntervalSupported (void) const
	Return whether the device has SGI support enabled. 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 HeCapabilities >	GetStationHeCapabilities (Mac48Address from)
	Return the HE capabilities sent by the remote station. More...

Ptr< const HtCapabilities >	GetStationHtCapabilities (Mac48Address from)
	Return the HT capabilities sent by the remote station. More...

Ptr< const VhtCapabilities >	GetStationVhtCapabilities (Mac48Address from)
	Return the VHT capabilities sent by the remote station. 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 (Mac48Address address) const
	Return whether the station supports VHT or not. More...

bool	GetVhtSupported (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 (Ptr< const WifiMacQueueItem > mpdu, 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 (Ptr< const WifiMacQueueItem > mpdu)

bool	NeedRetransmission (Ptr< const WifiMacQueueItem > mpdu)

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, uint16_t nSuccessfulMpdus, uint16_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 (Ptr< const WifiMacQueueItem > mpdu)
	Should be invoked whenever the AckTimeout associated to a transmission attempt expires. More...

void	ReportDataOk (Ptr< const WifiMacQueueItem > mpdu, double ackSnr, WifiMode ackMode, double dataSnr, WifiTxVector dataTxVector)
	Should be invoked whenever we receive the ACK associated to a data packet we just sent. More...

void	ReportFinalDataFailed (Ptr< const WifiMacQueueItem > mpdu)
	Should be invoked after calling ReportDataFailed if NeedRetransmission returns false. More...

void	ReportFinalRtsFailed (const WifiMacHeader &header)
	Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false. More...

void	ReportRtsFailed (const WifiMacHeader &header)
	Should be invoked whenever the RtsTimeout associated to a transmission attempt expires. More...

void	ReportRtsOk (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, RxSignalInfo rxSignalInfo, WifiTxVector txVector)

void	Reset (void)
	Reset the station, invoked in a STA upon dis-association or in an AP upon reboot. More...

void	SetAssociationId (Mac48Address remoteAddress, uint16_t aid)
	Record the AID of a remote station. 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	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	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...

bool	UseLdpcForDestination (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<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. 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 ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] 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)
	Register this type. 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 Member Functions
void	CheckInit (AparfWifiRemoteStation *station)
	Check for initializations. More...

WifiRemoteStation *	DoCreateStation (void) const override

WifiTxVector	DoGetDataTxVector (WifiRemoteStation *station) override

WifiTxVector	DoGetRtsTxVector (WifiRemoteStation *station) override

void	DoInitialize (void) override
	Initialize() implementation. More...

void	DoReportDataFailed (WifiRemoteStation *station) override
	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) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportFinalDataFailed (WifiRemoteStation *station) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportFinalRtsFailed (WifiRemoteStation *station) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportRtsFailed (WifiRemoteStation *station) override
	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) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

Private Attributes
uint32_t	m_failMax
	The minimum number of failed transmissions to try a new power or rate. More...

uint8_t	m_maxPower
	Maximal power level. More...

uint8_t	m_minPower
	Minimal power level. More...

TracedCallback< double, double, Mac48Address >	m_powerChange
	The trace source fired when the transmission power changes. More...

uint8_t	m_powerDec
	Step size for decrement the power. More...

uint8_t	m_powerInc
	Step size for increment the power. More...

uint32_t	m_powerMax
	The maximum number of power changes. More...

TracedCallback< DataRate, DataRate, Mac48Address >	m_rateChange
	The trace source fired when the transmission rate changes. More...

uint8_t	m_rateDec
	Step size for decrement the rate. More...

uint8_t	m_rateInc
	Step size for increment the rate. More...

uint32_t	m_succesMax1
	The minimum number of successful transmissions in "High" state to try a new power or rate. More...

uint32_t	m_succesMax2
	The minimum number of successful transmissions in "Low" state to try a new power or rate. More...

Additional Inherited Members
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...

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...

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...

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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

APARF Power and rate control algorithm.

This class implements the High Performance power and rate control algorithm described in Dynamic data rate and transmit power adjustment in IEEE 802.11 wireless LANs by Chevillat, P.; Jelitto, J. and Truong, H. L. in International Journal of Wireless Information 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 modes and will error exit if the user tries to configure this RAA with a Wi-Fi MAC that supports 802.11n or higher.

Config Paths

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

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

Attributes

SuccessThreshold1: The minimum number of successful transmissions in "High" state to try a new power or rate.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 3
- Flags: construct write read
SuccessThreshold2: The minimum number of successful transmissions in "Low" state to try a new power or rate.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
FailThreshold: The minimum number of failed transmissions to try a new power or rate.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read
PowerThreshold: The maximum number of power changes.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
PowerDecrementStep: Step size for decrement the power.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
PowerIncrementStep: Step size for increment the power.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
RateDecrementStep: Step size for decrement the rate.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
RateIncrementStep: Step size for increment the rate.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- 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

PowerChange: The transmission power has change
Callback signature: ns3::WifiRemoteStationManager::PowerChangeTracedCallback
RateChange: The transmission rate has change
Callback signature: ns3::WifiRemoteStationManager::RateChangeTracedCallback

TraceSources defined in parent class ns3::WifiRemoteStationManager

MacTxRtsFailed: The transmission of a RTS by the MAC layer has failed
Callback signature: ns3::Mac48Address::TracedCallback
MacTxDataFailed: The transmission of a data packet by the MAC layer has failed
Callback signature: ns3::Mac48Address::TracedCallback
MacTxFinalRtsFailed: The transmission of a RTS has exceeded the maximum number of attempts
Callback signature: ns3::Mac48Address::TracedCallback
MacTxFinalDataFailed: The transmission of a data packet has exceeded the maximum number of attempts
Callback signature: ns3::Mac48Address::TracedCallback

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

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

Member Enumeration Documentation

◆ State

enum ns3::AparfWifiManager::State

Enumeration of the possible states of the channel.

Enumerator
High
Low
Spread

Definition at line 61 of file aparf-wifi-manager.h.

Constructor & Destructor Documentation

◆ AparfWifiManager()

ns3::AparfWifiManager::AparfWifiManager ( )

Definition at line 118 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ ~AparfWifiManager()

ns3::AparfWifiManager::~AparfWifiManager ( )

virtual

Definition at line 123 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckInit()

void ns3::AparfWifiManager::CheckInit ( AparfWifiRemoteStation * station )

private

Check for initializations.

Parameters

station The remote station.

Definition at line 176 of file aparf-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiPhy::GetPowerDbm(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiRemoteStationState::m_address, ns3::AparfWifiRemoteStation::m_critRateIndex, ns3::AparfWifiRemoteStation::m_initialized, m_maxPower, ns3::AparfWifiRemoteStation::m_nSupported, m_powerChange, ns3::AparfWifiRemoteStation::m_powerLevel, ns3::AparfWifiRemoteStation::m_prevPowerLevel, ns3::AparfWifiRemoteStation::m_prevRateIndex, m_rateChange, ns3::AparfWifiRemoteStation::m_rateIndex, and ns3::WifiRemoteStation::m_state.

Referenced by DoGetDataTxVector(), DoReportDataFailed(), and DoReportDataOk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoCreateStation()

WifiRemoteStation * ns3::AparfWifiManager::DoCreateStation ( void ) const

overrideprivatevirtual

Returns: a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 156 of file aparf-wifi-manager.cc.

References High, ns3::AparfWifiRemoteStation::m_aparfState, m_failMax, ns3::AparfWifiRemoteStation::m_failThreshold, ns3::AparfWifiRemoteStation::m_initialized, ns3::AparfWifiRemoteStation::m_nFailed, ns3::AparfWifiRemoteStation::m_nSuccess, ns3::AparfWifiRemoteStation::m_pCount, ns3::AparfWifiRemoteStation::m_powerLevel, ns3::AparfWifiRemoteStation::m_rateIndex, m_succesMax1, ns3::AparfWifiRemoteStation::m_successThreshold, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ DoGetDataTxVector()

WifiTxVector ns3::AparfWifiManager::DoGetDataTxVector ( WifiRemoteStation * station )

overrideprivatevirtual

Parameters

station the 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 339 of file aparf-wifi-manager.cc.

References CheckInit(), ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiMode::GetDataRate(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiPhy::GetPowerDbm(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiRemoteStationState::m_address, m_powerChange, ns3::AparfWifiRemoteStation::m_powerLevel, ns3::AparfWifiRemoteStation::m_prevPowerLevel, ns3::AparfWifiRemoteStation::m_prevRateIndex, m_rateChange, ns3::AparfWifiRemoteStation::m_rateIndex, ns3::WifiRemoteStation::m_state, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoGetRtsTxVector()

WifiTxVector ns3::AparfWifiManager::DoGetRtsTxVector ( WifiRemoteStation * station )

overrideprivatevirtual

Parameters

station the station that we need to communicate

Returns: the transmission mode to use to send an RTS to the station

Note: This method is called before sending an RTS to a station to decide which transmission mode to use for the RTS.

Todo:: we could/should implement the ARF algorithm for RTS only by picking a single rate within the BasicRateSet.

Implements ns3::WifiRemoteStationManager.

Definition at line 368 of file aparf-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNonErpSupported(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiRemoteStationManager::GetUseNonErpProtection(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::AparfWifiManager::DoInitialize ( void )

overrideprivatevirtual

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 138 of file aparf-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetHeSupported(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::WifiRemoteStationManager::GetVhtSupported(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoReportDataFailed()

void ns3::AparfWifiManager::DoReportDataFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 201 of file aparf-wifi-manager.cc.

Here is the call graph for this function:

◆ DoReportDataOk()

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

overrideprivatevirtual

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

station	the station that we successfully sent RTS
ackSnr	the SNR of the ACK we received
ackMode	the WifiMode the receiver used to send the ACK
dataSnr	the SNR of the DATA we sent
dataChannelWidth	the channel width (in MHz) of the DATA we sent
dataNss	the number of spatial streams used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 258 of file aparf-wifi-manager.cc.

Here is the call graph for this function:

◆ DoReportFinalDataFailed()

void ns3::AparfWifiManager::DoReportFinalDataFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 333 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportFinalRtsFailed()

void ns3::AparfWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 327 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsFailed()

void ns3::AparfWifiManager::DoReportRtsFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 196 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsOk()

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

overrideprivatevirtual

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

station	the station that we successfully sent RTS
ctsSnr	the SNR of the CTS we received
ctsMode	the WifiMode the receiver used to send the CTS
rtsSnr	the SNR of the RTS we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 251 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRxOk()

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

overrideprivatevirtual

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

station	the station that sent the DATA to us
rxSnr	the SNR of the DATA we received
txMode	the WifiMode the sender used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 245 of file aparf-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::AparfWifiManager::GetTypeId ( void )

static

Register this type.

Returns: The object TypeId.

Definition at line 60 of file aparf-wifi-manager.cc.

References m_failMax, m_powerChange, m_powerDec, m_powerInc, m_powerMax, m_rateChange, m_rateDec, m_rateInc, m_succesMax1, m_succesMax2, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetupPhy()

void ns3::AparfWifiManager::SetupPhy ( const Ptr< WifiPhy > phy )

overridevirtual

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

Parameters

phy	the PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 129 of file aparf-wifi-manager.cc.

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

Here is the call graph for this function:

Member Data Documentation

◆ m_failMax

uint32_t ns3::AparfWifiManager::m_failMax

private

The minimum number of failed transmissions to try a new power or rate.

Definition at line 93 of file aparf-wifi-manager.h.

Referenced by DoCreateStation(), and GetTypeId().

◆ m_maxPower

uint8_t ns3::AparfWifiManager::m_maxPower

private

Maximal power level.

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

Referenced by CheckInit(), DoReportDataFailed(), DoReportDataOk(), and SetupPhy().

◆ m_minPower

uint8_t ns3::AparfWifiManager::m_minPower

private

Minimal power level.

Differently form rate, power levels do not depend on the remote station. The levels depend only on the physical layer of the device.

Definition at line 105 of file aparf-wifi-manager.h.

Referenced by DoReportDataOk(), and SetupPhy().

◆ m_powerChange

TracedCallback<double, double, Mac48Address> ns3::AparfWifiManager::m_powerChange

private

The trace source fired when the transmission power changes.

Definition at line 115 of file aparf-wifi-manager.h.

Referenced by CheckInit(), DoGetDataTxVector(), and GetTypeId().

◆ m_powerDec

uint8_t ns3::AparfWifiManager::m_powerDec

private

Step size for decrement the power.

Definition at line 96 of file aparf-wifi-manager.h.

Referenced by DoReportDataOk(), and GetTypeId().

◆ m_powerInc

uint8_t ns3::AparfWifiManager::m_powerInc

private

Step size for increment the power.

Definition at line 95 of file aparf-wifi-manager.h.

Referenced by DoReportDataFailed(), and GetTypeId().

◆ m_powerMax

uint32_t ns3::AparfWifiManager::m_powerMax

private

The maximum number of power changes.

Definition at line 94 of file aparf-wifi-manager.h.

Referenced by DoReportDataOk(), and GetTypeId().

◆ m_rateChange

TracedCallback<DataRate, DataRate, Mac48Address> ns3::AparfWifiManager::m_rateChange

private

The trace source fired when the transmission rate changes.

Definition at line 119 of file aparf-wifi-manager.h.

Referenced by CheckInit(), DoGetDataTxVector(), and GetTypeId().

◆ m_rateDec

uint8_t ns3::AparfWifiManager::m_rateDec

private

Step size for decrement the rate.

Definition at line 98 of file aparf-wifi-manager.h.

Referenced by DoReportDataFailed(), and GetTypeId().

◆ m_rateInc

uint8_t ns3::AparfWifiManager::m_rateInc

private

Step size for increment the rate.

Definition at line 97 of file aparf-wifi-manager.h.

Referenced by DoReportDataOk(), and GetTypeId().

◆ m_succesMax1

uint32_t ns3::AparfWifiManager::m_succesMax1

private

The minimum number of successful transmissions in "High" state to try a new power or rate.

Definition at line 91 of file aparf-wifi-manager.h.

Referenced by DoCreateStation(), DoReportDataFailed(), DoReportDataOk(), and GetTypeId().

◆ m_succesMax2

uint32_t ns3::AparfWifiManager::m_succesMax2

private

The minimum number of successful transmissions in "Low" state to try a new power or rate.

Definition at line 92 of file aparf-wifi-manager.h.

Referenced by DoReportDataFailed(), and GetTypeId().

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

src/wifi/model/rate-control/aparf-wifi-manager.h
src/wifi/model/rate-control/aparf-wifi-manager.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::WifiRemoteStationManager

TraceSources

TraceSources defined in parent class ns3::WifiRemoteStationManager

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ AparfWifiManager()

◆ ~AparfWifiManager()

Member Function Documentation

◆ CheckInit()

◆ DoCreateStation()

◆ DoGetDataTxVector()

◆ DoGetRtsTxVector()

◆ DoInitialize()

◆ DoReportDataFailed()

◆ DoReportDataOk()

◆ DoReportFinalDataFailed()

◆ DoReportFinalRtsFailed()

◆ DoReportRtsFailed()

◆ DoReportRtsOk()

◆ DoReportRxOk()

◆ GetTypeId()

◆ SetupPhy()

Member Data Documentation

◆ m_failMax

◆ m_maxPower

◆ m_minPower

◆ m_powerChange

◆ m_powerDec

◆ m_powerInc

◆ m_powerMax

◆ m_rateChange

◆ m_rateDec

◆ m_rateInc

◆ m_succesMax1

◆ m_succesMax2