hold a list of per-remote-station state. More...

#include "wifi-remote-station-manager.h"

Inheritance diagram for ns3::WifiRemoteStationManager:

Collaboration diagram for ns3::WifiRemoteStationManager:

Public Types
typedef void(*	PowerChangeTracedCallback) (double oldPower, double newPower, Mac48Address remoteAddress)
	TracedCallback signature for power change events.

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.

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

using	StationStates
	A map of WifiRemoteStationStates with Mac48Address as key.

Public Member Functions
	WifiRemoteStationManager ()

	~WifiRemoteStationManager () override

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.

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.

void	AddBasicMcs (WifiMode mcs)
	Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS.

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.

void	AddStationEhtCapabilities (Mac48Address from, EhtCapabilities ehtCapabilities)
	Records EHT capabilities of the remote station.

void	AddStationHe6GhzCapabilities (const Mac48Address &from, const He6GhzBandCapabilities &he6GhzCapabilities)
	Records HE 6 GHz Band Capabilities of a remote station.

void	AddStationHeCapabilities (Mac48Address from, HeCapabilities heCapabilities)
	Records HE capabilities of the remote station.

void	AddStationHtCapabilities (Mac48Address from, HtCapabilities htCapabilities)
	Records HT capabilities of the remote station.

void	AddStationMleCommonInfo (Mac48Address from, const std::shared_ptr< CommonInfoBasicMle > &mleCommonInfo)
	Records the Common Info field advertised by the given remote station in a Multi-Link Element.

void	AddStationVhtCapabilities (Mac48Address from, VhtCapabilities vhtCapabilities)
	Records VHT capabilities of the remote station.

void	AddSupportedErpSlotTime (Mac48Address address, bool isShortSlotTimeSupported)
	Record whether the short ERP slot time is supported by the station.

void	AddSupportedMcs (Mac48Address address, WifiMode mcs)
	Record the MCS index supported by the station.

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.

void	AddSupportedPhyPreamble (Mac48Address address, bool isShortPreambleSupported)
	Record whether the short PHY preamble is supported by the station.

void	AdjustTxVectorForIcf (WifiTxVector &txVector) const
	Adjust the TXVECTOR for an initial Control frame to ensure that the modulation class is non-HT and the rate is 6 Mbps, 12 Mbps or 24 Mbps.

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

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.

std::optional< Mac48Address >	GetAffiliatedStaAddress (const Mac48Address &mldAddress) const
	Get the address of the remote station operating on this link and affiliated with the MLD having the given MAC address, if any.

uint16_t	GetAssociationId (Mac48Address remoteAddress) const
	Get the AID of a remote station.

WifiMode	GetBasicMcs (uint8_t i) const
	Return the MCS at the given list index.

WifiMode	GetBasicMode (uint8_t i) const
	Return a basic mode from the set of basic modes.

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.

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

WifiMode	GetControlAnswerMode (WifiMode reqMode) const
	Get control answer mode function.

WifiTxVector	GetCtsToSelfTxVector ()
	Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote station manager.

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.

WifiTxVector	GetDataTxVector (const WifiMacHeader &header, MHz_u allowedWidth)

WifiMode	GetDefaultMcs () const
	Return the default Modulation and Coding Scheme (MCS) index.

WifiMode	GetDefaultMode () const
	Return the default transmission mode.

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

uint8_t	GetDefaultTxPowerLevel () const

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

bool	GetEhtSupported () const
	Return whether the device has EHT capability support enabled.

bool	GetEhtSupported (Mac48Address address) const
	Return whether the station supports EHT or not.

bool	GetEmlsrEnabled (const Mac48Address &address) const

bool	GetEmlsrSupported (const Mac48Address &address) const

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

uint32_t	GetFragmentationThreshold () const
	Return the fragmentation threshold.

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

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

Time	GetGuardInterval () const
	Return the supported HE guard interval duration.

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

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

bool	GetHtSupported () const
	Return whether the device has HT capability support enabled on the link this manager is associated with.

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

WifiRemoteStationInfo	GetInfo (Mac48Address address)

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

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

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

uint8_t	GetMaxNumberOfTransmitStreams () const

std::optional< Mac48Address >	GetMldAddress (const Mac48Address &address) const
	Get the address of the MLD the given station is affiliated with, if any.

std::optional< dBm_u >	GetMostRecentRssi (Mac48Address address) const

uint8_t	GetNBasicMcs () const
	Return the number of basic MCS index.

uint8_t	GetNBasicModes () const
	Return the number of basic modes we support.

uint8_t	GetNMcsSupported (Mac48Address address) const
	Return the number of MCS supported by the station.

uint32_t	GetNNonErpBasicModes () const
	Return the number of non-ERP basic modes we support.

WifiMode	GetNonErpBasicMode (uint8_t i) const
	Return a basic mode from the set of basic modes that is not an ERP mode.

WifiMode	GetNonUnicastMode () const
	Return a mode for non-unicast packets.

uint8_t	GetNumberOfAntennas () const

uint8_t	GetNumberOfSupportedStreams (Mac48Address address) const
	Return the number of spatial streams supported by the station.

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

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

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

WifiTxVector	GetRtsTxVector (Mac48Address address, MHz_u allowedWidth)

bool	GetShortGuardIntervalSupported () const
	Return whether the device has SGI support enabled.

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

bool	GetShortPreambleEnabled () const
	Return whether the device uses short PHY preambles.

bool	GetShortPreambleSupported (Mac48Address address) const
	Return whether the station supports short PHY preamble or not.

bool	GetShortSlotTimeEnabled () const
	Return whether the device uses short slot time.

bool	GetShortSlotTimeSupported (Mac48Address address) const
	Return whether the station supports short ERP slot time or not.

Ptr< const EhtCapabilities >	GetStationEhtCapabilities (Mac48Address from)
	Return the EHT capabilities sent by the remote station.

std::optional< std::reference_wrapper< CommonInfoBasicMle::EmlCapabilities > >	GetStationEmlCapabilities (const Mac48Address &from)

Ptr< const He6GhzBandCapabilities >	GetStationHe6GhzCapabilities (const Mac48Address &from) const
	Return the HE 6 GHz Band Capabilities sent by a remote station.

Ptr< const HeCapabilities >	GetStationHeCapabilities (Mac48Address from)
	Return the HE capabilities sent by the remote station.

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

std::optional< std::reference_wrapper< CommonInfoBasicMle::MldCapabilities > >	GetStationMldCapabilities (const Mac48Address &from)

Ptr< const VhtCapabilities >	GetStationVhtCapabilities (Mac48Address from)
	Return the VHT capabilities sent by the remote station.

bool	GetUseNonErpProtection () const
	Return whether the device supports protection of non-ERP stations.

bool	GetUseNonHtProtection () const
	Return whether the device supports protection of non-HT stations.

bool	GetVhtSupported () const
	Return whether the device has VHT capability support enabled on the link this manager is associated with.

bool	GetVhtSupported (Mac48Address address) const
	Return whether the station supports VHT or not.

bool	IsAssociated (Mac48Address address) const
	Return whether the station associated.

bool	IsAssocRefused (Mac48Address address) const
	Return whether we refused an association request from the given station.

bool	IsBrandNew (Mac48Address address) const
	Return whether the station state is brand new.

bool	IsInPsMode (const Mac48Address &address) const
	Return whether the STA is currently in Power Save mode.

bool	IsLastFragment (Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)

bool	IsWaitAssocTxOk (Mac48Address address) const
	Return whether we are waiting for an ACK for the association response we sent.

bool	NeedCtsToSelf (WifiTxVector txVector)
	Return if we need to do CTS-to-self before sending a DATA.

bool	NeedFragmentation (Ptr< const WifiMpdu > mpdu)

bool	NeedRetransmission (Ptr< const WifiMpdu > mpdu)

bool	NeedRts (const WifiMacHeader &header, const WifiTxParameters &txParams)

void	RecordAssocRefused (Mac48Address address)
	Records that association request was refused.

void	RecordDisassociated (Mac48Address address)
	Records that the STA was disassociated.

void	RecordGotAssocTxFailed (Mac48Address address)
	Records that we missed an ACK for the association response we sent.

void	RecordGotAssocTxOk (Mac48Address address)
	Records that we got an ACK for the association response we sent.

void	RecordWaitAssocTxOk (Mac48Address address)
	Records that we are waiting for an ACK for the association response we sent.

void	RemoveAllSupportedMcs (Mac48Address address)
	Invoked in a STA or AP to delete all of the supported MCS by a destination.

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.

void	ReportDataFailed (Ptr< const WifiMpdu > mpdu)
	Should be invoked whenever the AckTimeout associated to a transmission attempt expires.

void	ReportDataOk (Ptr< const WifiMpdu > 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.

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

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

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

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.

void	ReportRxOk (Mac48Address address, RxSignalInfo rxSignalInfo, WifiTxVector txVector)

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

void	SetAssociationId (Mac48Address remoteAddress, uint16_t aid)
	Record the AID of a remote station.

void	SetDefaultTxPowerLevel (uint8_t txPower)
	Set the default transmission power level.

void	SetEmlsrEnabled (const Mac48Address &from, bool emlsrEnabled)

void	SetFragmentationThreshold (uint32_t threshold)
	Sets a fragmentation threshold.

void	SetMaxSlrc (uint32_t maxSlrc)
	Sets the maximum STA long retry count (SLRC).

void	SetMaxSsrc (uint32_t maxSsrc)
	Sets the maximum STA short retry count (SSRC).

void	SetPsMode (const Mac48Address &address, bool isInPsMode)
	Register whether the STA is in Power Save mode or not.

void	SetQosSupport (Mac48Address from, bool qosSupported)
	Records QoS support of the remote station.

void	SetRtsCtsThreshold (uint32_t threshold)
	Sets the RTS threshold.

void	SetShortPreambleEnabled (bool enable)
	Enable or disable short PHY preambles.

void	SetShortSlotTimeEnabled (bool enable)
	Enable or disable short slot time.

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.

virtual void	SetupPhy (const Ptr< WifiPhy > phy)
	Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported.

void	SetUseNonErpProtection (bool enable)
	Enable or disable protection for non-ERP stations.

void	SetUseNonHtProtection (bool enable)
	Enable or disable protection for non-HT stations.

bool	UseLdpcForDestination (Mac48Address dest) const

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

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

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

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

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

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

Mac48Address	GetAddress (const WifiRemoteStation *station) const
	Return the address of the station.

bool	GetAggregation (const WifiRemoteStation *station) const
	Return whether the given station supports A-MPDU.

MHz_u	GetChannelWidth (const WifiRemoteStation *station) const
	Return the channel width supported by the station.

bool	GetEhtSupported (const WifiRemoteStation *station) const
	Return whether the given station is EHT capable.

bool	GetEmlsrEnabled (const WifiRemoteStation *station) const

bool	GetEmlsrSupported (const WifiRemoteStation *station) const

Time	GetGuardInterval (const WifiRemoteStation *station) const
	Return the HE guard interval duration supported by the station.

bool	GetHeSupported (const WifiRemoteStation *station) const
	Return whether the given station is HE capable.

bool	GetHtSupported (const WifiRemoteStation *station) const
	Return whether the given station is HT capable.

WifiMode	GetMcsSupported (const WifiRemoteStation *station, uint8_t i) const
	Return the WifiMode supported by the specified station at the specified index.

uint8_t	GetNess (const WifiRemoteStation *station) const

uint8_t	GetNMcsSupported (const WifiRemoteStation *station) const
	Return the number of MCS supported by the given station.

uint32_t	GetNNonErpSupported (const WifiRemoteStation *station) const
	Return the number of non-ERP modes supported by the given station.

WifiMode	GetNonErpSupported (const WifiRemoteStation *station, uint8_t i) const
	Return whether non-ERP mode associated with the specified station at the specified index.

uint8_t	GetNSupported (const WifiRemoteStation *station) const
	Return the number of modes supported by the given station.

uint8_t	GetNumberOfSupportedStreams (const WifiRemoteStation *station) const
	Return the number of supported streams the station has.

bool	GetQosSupported (const WifiRemoteStation *station) const
	Return whether the given station is QoS capable.

bool	GetShortGuardIntervalSupported (const WifiRemoteStation *station) const
	Return whether the given station supports HT/VHT short guard interval.

WifiMode	GetSupported (const WifiRemoteStation *station, uint8_t i) const
	Return whether mode associated with the specified station at the specified index.

bool	GetVhtSupported (const WifiRemoteStation *station) const
	Return whether the given station is VHT capable.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Private Member Functions
virtual WifiRemoteStation *	DoCreateStation () const =0

virtual WifiTxVector	DoGetDataTxVector (WifiRemoteStation *station, MHz_u allowedWidth)=0

uint32_t	DoGetFragmentationThreshold () const
	Return the current fragmentation threshold.

virtual WifiTxVector	DoGetRtsTxVector (WifiRemoteStation *station)=0

virtual bool	DoNeedFragmentation (WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)

virtual bool	DoNeedRetransmission (WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)

virtual bool	DoNeedRts (WifiRemoteStation *station, uint32_t size, bool normally)

virtual void	DoReportAmpduTxStatus (WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, MHz_u dataChannelWidth, uint8_t dataNss)
	Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed.

virtual void	DoReportDataFailed (WifiRemoteStation *station)=0
	This method is a pure virtual method that must be implemented by the sub-class.

virtual void	DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, MHz_u dataChannelWidth, uint8_t dataNss)=0
	This method is a pure virtual method that must be implemented by the sub-class.

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

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

virtual void	DoReportRtsFailed (WifiRemoteStation *station)=0
	This method is a pure virtual method that must be implemented by the sub-class.

virtual void	DoReportRtsOk (WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)=0
	This method is a pure virtual method that must be implemented by the sub-class.

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

void	DoSetFragmentationThreshold (uint32_t threshold)
	Actually sets the fragmentation threshold, it also checks the validity of the given threshold.

uint32_t	GetNFragments (Ptr< const WifiMpdu > mpdu)
	Return the number of fragments needed for the given packet.

uint16_t	GetStaId (Mac48Address address, const WifiTxVector &txVector) const
	If the given TXVECTOR is used for a MU transmission, return the STAID of the station with the given address if we are an AP or our own STAID if we are a STA associated with some AP.

WifiRemoteStation *	Lookup (Mac48Address address) const
	Return the station associated with the given address.

std::shared_ptr< WifiRemoteStationState >	LookupState (Mac48Address address) const
	Return the state of the station associated with the given address.

Private Attributes
WifiModeList	m_bssBasicMcsSet
	basic MCS set

WifiModeList	m_bssBasicRateSet
	This member is the list of WifiMode objects that comprise the BSSBasicRateSet parameter.

uint8_t	m_defaultTxPowerLevel
	Default transmission power level.

ProtectionMode	m_erpProtectionMode
	Protection mode for ERP stations when non-ERP stations are detected.

uint32_t	m_fragmentationThreshold
	Current threshold for fragmentation.

ProtectionMode	m_htProtectionMode
	Protection mode for HT stations when non-HT stations are detected.

TracedCallback< Mac48Address >	m_macTxDataFailed
	The trace source fired when the transmission of a single data packet has failed.

TracedCallback< Mac48Address >	m_macTxFinalDataFailed
	The trace source fired when the transmission of a data packet has exceeded the maximum number of attempts.

TracedCallback< Mac48Address >	m_macTxFinalRtsFailed
	The trace source fired when the transmission of a RTS has exceeded the maximum number of attempts.

TracedCallback< Mac48Address >	m_macTxRtsFailed
	The trace source fired when the transmission of a single RTS has failed.

uint32_t	m_maxSlrc
	Maximum STA long retry count (SLRC)

uint32_t	m_maxSsrc
	Maximum STA short retry count (SSRC)

WifiMode	m_nonUnicastMode
	Transmission mode for non-unicast Data frames.

uint32_t	m_rtsCtsThreshold
	Threshold for RTS/CTS.

Time	m_rtsCtsTxDurationThresh
	TX duration threshold for RTS/CTS.

bool	m_shortPreambleEnabled
	flag if short PHY preamble is enabled

bool	m_shortSlotTimeEnabled
	flag if short slot time is enabled

std::array< uint32_t, AC_BE_NQOS >	m_slrc
	long retry count per AC

std::array< uint32_t, AC_BE_NQOS >	m_ssrc
	short retry count per AC

StationStates	m_states
	States of known stations.

Stations	m_stations
	Information for each known stations.

bool	m_useNonErpProtection
	flag if protection for non-ERP stations against ERP transmissions is enabled

bool	m_useNonHtProtection
	flag if protection for non-HT stations against HT transmissions is enabled

Ptr< WifiMac >	m_wifiMac
	This is a pointer to the WifiMac associated with this WifiRemoteStationManager that is set on call to WifiRemoteStationManager::SetupMac().

Ptr< WifiPhy >	m_wifiPhy
	This is a pointer to the WifiPhy associated with this WifiRemoteStationManager that is set on call to WifiRemoteStationManager::SetupPhy().

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

hold a list of per-remote-station state.

See also: ns3::WifiRemoteStation.

Definition at line 128 of file wifi-remote-station-manager.h.

Member Typedef Documentation

◆ PowerChangeTracedCallback

typedef void(* ns3::WifiRemoteStationManager::PowerChangeTracedCallback) (double oldPower, double newPower, Mac48Address remoteAddress)

TracedCallback signature for power change events.

Parameters

[in]	oldPower	The previous power (in dBm).
[in]	newPower	The new power (in dBm).
[in]	address	The remote station MAC address.

Definition at line 1073 of file wifi-remote-station-manager.h.

◆ RateChangeTracedCallback

typedef void(* ns3::WifiRemoteStationManager::RateChangeTracedCallback) (DataRate oldRate, DataRate newRate, Mac48Address remoteAddress)

TracedCallback signature for rate change events.

Parameters

[in]	oldRate	The previous data rate.
[in]	newRate	The new data rate.
[in]	address	The remote station MAC address.

Definition at line 1084 of file wifi-remote-station-manager.h.

◆ Stations

using ns3::WifiRemoteStationManager::Stations = std::unordered_map<Mac48Address, WifiRemoteStation*, WifiAddressHash>

A map of WifiRemoteStations with Mac48Address as key.

Definition at line 150 of file wifi-remote-station-manager.h.

◆ StationStates

using ns3::WifiRemoteStationManager::StationStates

Initial value:

std::unordered_map<Mac48Address, std::shared_ptr<WifiRemoteStationState>, WifiAddressHash>

A map of WifiRemoteStationStates with Mac48Address as key.

Definition at line 154 of file wifi-remote-station-manager.h.

Member Enumeration Documentation

◆ ProtectionMode

enum ns3::WifiRemoteStationManager::ProtectionMode

ProtectionMode enumeration.

Enumerator
RTS_CTS
CTS_TO_SELF

Definition at line 141 of file wifi-remote-station-manager.h.

Constructor & Destructor Documentation

◆ WifiRemoteStationManager()

ns3::WifiRemoteStationManager::WifiRemoteStationManager ( )

Definition at line 137 of file wifi-remote-station-manager.cc.

References m_slrc, m_ssrc, and NS_LOG_FUNCTION.

◆ ~WifiRemoteStationManager()

ns3::WifiRemoteStationManager::~WifiRemoteStationManager ( )

override

Definition at line 148 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddAllSupportedMcs()

void ns3::WifiRemoteStationManager::AddAllSupportedMcs ( Mac48Address address )

Invoked in a STA or AP to store all of the MCS supported by a destination which is also supported locally.

Parameters

address the address of the station being recorded

Definition at line 374 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetMcsList(), LookupState(), m_wifiPhy, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddAllSupportedModes()

void ns3::WifiRemoteStationManager::AddAllSupportedModes ( Mac48Address address )

Invoked in a STA or AP to store all of the modes supported by a destination which is also supported locally.

The set of supported modes includes the BSSBasicRateSet.

Parameters

address the address of the station being recorded

Definition at line 357 of file wifi-remote-station-manager.cc.

References AddBasicMode(), ns3::WifiPhy::GetModeList(), LookupState(), m_wifiPhy, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddBasicMcs()

void ns3::WifiRemoteStationManager::AddBasicMcs ( WifiMode mcs )

Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS.

Parameters

mcs	the WifiMode to be added to the basic MCS set

Definition at line 1829 of file wifi-remote-station-manager.cc.

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

Here is the call graph for this function:

◆ AddBasicMode()

void ns3::WifiRemoteStationManager::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.

Invoked in an AP to configure the BSSBasicRateSet.

Parameters

mode	the WifiMode to be added to the basic mode set

Definition at line 1758 of file wifi-remote-station-manager.cc.

References ns3::WifiMode::GetModulationClass(), NS_FATAL_ERROR, NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_HT.

Referenced by AddAllSupportedModes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddStationEhtCapabilities()

void ns3::WifiRemoteStationManager::AddStationEhtCapabilities	(	Mac48Address	from,
		EhtCapabilities	ehtCapabilities )

Records EHT capabilities of the remote station.

Parameters

from	the address of the station being recorded
ehtCapabilities	the EHT capabilities of the station

Definition at line 1592 of file wifi-remote-station-manager.cc.

References ns3::EhtCapabilities::GetHighestSupportedRxMcs(), NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_EHT.

Here is the call graph for this function:

◆ AddStationHe6GhzCapabilities()

void ns3::WifiRemoteStationManager::AddStationHe6GhzCapabilities	(	const Mac48Address &	from,
		const He6GhzBandCapabilities &	he6GhzCapabilities )

Records HE 6 GHz Band Capabilities of a remote station.

Parameters

from	the address of the remote station
he6GhzCapabilities	the HE 6 GHz Band Capabilities of the remote station

Definition at line 1580 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

◆ AddStationHeCapabilities()

void ns3::WifiRemoteStationManager::AddStationHeCapabilities	(	Mac48Address	from,
		HeCapabilities	heCapabilities )

Records HE capabilities of the remote station.

Parameters

from	the address of the station being recorded
heCapabilities	the HE capabilities of the station

Definition at line 1530 of file wifi-remote-station-manager.cc.

References ns3::HeCapabilities::GetChannelWidthSet(), ns3::HeCapabilities::GetHeSuPpdu1xHeLtf800nsGi(), ns3::HeCapabilities::GetHighestMcsSupported(), ns3::NanoSeconds(), NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_PHY_BAND_2_4GHZ, ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_PHY_BAND_6GHZ.

Here is the call graph for this function:

◆ AddStationHtCapabilities()

void ns3::WifiRemoteStationManager::AddStationHtCapabilities	(	Mac48Address	from,
		HtCapabilities	htCapabilities )

Records HT capabilities of the remote station.

Parameters

from	the address of the station being recorded
htCapabilities	the HT capabilities of the station

Definition at line 1477 of file wifi-remote-station-manager.cc.

References ns3::HtCapabilities::GetSupportedChannelWidth(), ns3::HtCapabilities::IsSupportedMcs(), NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_HT.

Here is the call graph for this function:

◆ AddStationMleCommonInfo()

void ns3::WifiRemoteStationManager::AddStationMleCommonInfo	(	Mac48Address	from,
		const std::shared_ptr< CommonInfoBasicMle > &	mleCommonInfo )

Records the Common Info field advertised by the given remote station in a Multi-Link Element.

It includes the MLD address of the remote station.

Parameters

from	the address of the station being recorded
mleCommonInfo	the MLE Common Info advertised by the station

Definition at line 1614 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

◆ AddStationVhtCapabilities()

void ns3::WifiRemoteStationManager::AddStationVhtCapabilities	(	Mac48Address	from,
		VhtCapabilities	vhtCapabilities )

Records VHT capabilities of the remote station.

Parameters

from	the address of the station being recorded
vhtCapabilities	the VHT capabilities of the station

Definition at line 1502 of file wifi-remote-station-manager.cc.

References ns3::VhtCapabilities::GetSupportedChannelWidthSet(), ns3::VhtCapabilities::IsSupportedMcs(), NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_VHT.

Here is the call graph for this function:

◆ AddSupportedErpSlotTime()

void ns3::WifiRemoteStationManager::AddSupportedErpSlotTime	(	Mac48Address	address,
		bool	isShortSlotTimeSupported )

Record whether the short ERP slot time is supported by the station.

Parameters

address	the address of the station
isShortSlotTimeSupported	whether or not short ERP slot time is supported by the station

Definition at line 319 of file wifi-remote-station-manager.cc.

References LookupState(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddSupportedMcs()

void ns3::WifiRemoteStationManager::AddSupportedMcs	(	Mac48Address	address,
		WifiMode	mcs )

Record the MCS index supported by the station.

Parameters

address	the address of the station
mcs	the WifiMode supported by the station

Definition at line 393 of file wifi-remote-station-manager.cc.

References LookupState(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddSupportedMode()

void ns3::WifiRemoteStationManager::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.

The set of supported modes includes the BSSBasicRateSet.

Parameters

address	the address of the station being recorded
mode	the WifiMode supports by the station

Definition at line 328 of file wifi-remote-station-manager.cc.

References ns3::WifiMode::GetModulationClass(), LookupState(), NS_ASSERT, NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_DSSS, ns3::WIFI_MOD_CLASS_ERP_OFDM, ns3::WIFI_MOD_CLASS_HR_DSSS, and ns3::WIFI_MOD_CLASS_OFDM.

Here is the call graph for this function:

◆ AddSupportedPhyPreamble()

void ns3::WifiRemoteStationManager::AddSupportedPhyPreamble	(	Mac48Address	address,
		bool	isShortPreambleSupported )

Record whether the short PHY preamble is supported by the station.

Parameters

address	the address of the station
isShortPreambleSupported	whether or not short PHY preamble is supported by the station

Definition at line 310 of file wifi-remote-station-manager.cc.

References LookupState(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AdjustTxVectorForIcf()

void ns3::WifiRemoteStationManager::AdjustTxVectorForIcf ( WifiTxVector & txVector ) const

Adjust the TXVECTOR for an initial Control frame to ensure that the modulation class is non-HT and the rate is 6 Mbps, 12 Mbps or 24 Mbps.

Parameters

txVector the TXVECTOR to adjust

Definition at line 750 of file wifi-remote-station-manager.cc.

References ns3::WifiMode::GetDataRate(), ns3::ErpOfdmPhy::GetErpOfdmRate(), ns3::WifiTxVector::GetMode(), ns3::OfdmPhy::GetOfdmRate(), ns3::WifiPhy::GetPhyBand(), m_wifiPhy, NS_LOG_FUNCTION, ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetPreambleType(), ns3::WIFI_MOD_CLASS_HT, ns3::WIFI_PHY_BAND_2_4GHZ, and ns3::WIFI_PREAMBLE_LONG.

Here is the call graph for this function:

◆ AssignStreams()

int64_t ns3::WifiRemoteStationManager::AssignStreams ( int64_t stream )

virtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Reimplemented in ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Definition at line 182 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

◆ DoCreateStation()

virtual WifiRemoteStation * ns3::WifiRemoteStationManager::DoCreateStation ( ) const

privatepure virtual

Returns: a new station data structure

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

◆ DoDispose()

void ns3::WifiRemoteStationManager::DoDispose ( )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 154 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION, and Reset().

Here is the call graph for this function:

◆ DoGetDataTxVector()

virtual WifiTxVector ns3::WifiRemoteStationManager::DoGetDataTxVector	(	WifiRemoteStation *	station,
		MHz_u	allowedWidth )

privatepure virtual

Parameters

station	the station that we need to communicate
allowedWidth	the allowed width to send a packet to the station

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.

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by GetDataTxVector().

Here is the caller graph for this function:

◆ DoGetFragmentationThreshold()

uint32_t ns3::WifiRemoteStationManager::DoGetFragmentationThreshold ( ) const

private

Return the current fragmentation threshold.

Returns: the fragmentation threshold

Definition at line 1295 of file wifi-remote-station-manager.cc.

References m_fragmentationThreshold.

Referenced by GetFragmentationThreshold(), and GetTypeId().

Here is the caller graph for this function:

◆ DoGetRtsTxVector()

virtual WifiTxVector ns3::WifiRemoteStationManager::DoGetRtsTxVector ( WifiRemoteStation * station )

privatepure virtual

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.

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by GetRtsTxVector().

Here is the caller graph for this function:

◆ DoNeedFragmentation()

bool ns3::WifiRemoteStationManager::DoNeedFragmentation	(	WifiRemoteStation *	station,
		Ptr< const Packet >	packet,
		bool	normally )

privatevirtual

Parameters

station	the station that we need to communicate
packet	the packet to send
normally	indicates whether the normal 802.11 data fragmentation mechanism would request that the data packet is fragmented or not.

Returns: true if this packet should be fragmented, false otherwise.

Note: This method is called before sending a unicast packet.

Definition at line 1890 of file wifi-remote-station-manager.cc.

Referenced by NeedFragmentation().

Here is the caller graph for this function:

◆ DoNeedRetransmission()

bool ns3::WifiRemoteStationManager::DoNeedRetransmission	(	WifiRemoteStation *	station,
		Ptr< const Packet >	packet,
		bool	normally )

privatevirtual

Parameters

station	the station that we need to communicate
packet	the packet to send
normally	indicates whether the normal 802.11 data retransmission mechanism would request that the data is retransmitted or not.

Returns: true if we want to resend a packet after a failed transmission attempt, false otherwise.

Note: This method is called after any unicast packet transmission (control, management, or data) has been attempted and has failed.

Reimplemented in ns3::MinstrelHtWifiManager, and ns3::MinstrelWifiManager.

Definition at line 1882 of file wifi-remote-station-manager.cc.

Referenced by NeedRetransmission().

Here is the caller graph for this function:

◆ DoNeedRts()

bool ns3::WifiRemoteStationManager::DoNeedRts	(	WifiRemoteStation *	station,
		uint32_t	size,
		bool	normally )

privatevirtual

Parameters

station	the station that we need to communicate
size	the size of the frame to send in bytes
normally	indicates whether the normal 802.11 RTS enable mechanism would request that the RTS is sent or not.

Returns: true if we want to use an RTS/CTS handshake for this frame before sending it, false otherwise.

Note: This method is called before a unicast packet is sent on the medium.

Reimplemented in ns3::AarfcdWifiManager, ns3::CaraWifiManager, ns3::RraaWifiManager, and ns3::RrpaaWifiManager.

Definition at line 1876 of file wifi-remote-station-manager.cc.

Referenced by NeedRts().

Here is the caller graph for this function:

◆ DoReportAmpduTxStatus()

void ns3::WifiRemoteStationManager::DoReportAmpduTxStatus	(	WifiRemoteStation *	station,
		uint16_t	nSuccessfulMpdus,
		uint16_t	nFailedMpdus,
		double	rxSnr,
		double	dataSnr,
		MHz_u	dataChannelWidth,
		uint8_t	dataNss )

privatevirtual

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

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

Parameters

station	the station that sent the DATA to us
nSuccessfulMpdus	number of successfully transmitted MPDUs. A value of 0 means that the Block ACK was missed.
nFailedMpdus	number of unsuccessfuly transmitted MPDUs.
rxSnr	received SNR of the block ack frame itself
dataSnr	data SNR reported by remote station
dataChannelWidth	the channel width of the A-MPDU we sent
dataNss	the number of spatial streams used to send the A-MPDU

Reimplemented in ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, and ns3::ThompsonSamplingWifiManager.

Definition at line 1898 of file wifi-remote-station-manager.cc.

References NS_LOG_DEBUG.

Referenced by ReportAmpduTxStatus().

Here is the caller graph for this function:

◆ DoReportDataFailed()

virtual void ns3::WifiRemoteStationManager::DoReportDataFailed ( WifiRemoteStation * station )

privatepure virtual

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

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportDataFailed().

Here is the caller graph for this function:

◆ DoReportDataOk()

virtual void ns3::WifiRemoteStationManager::DoReportDataOk	(	WifiRemoteStation *	station,
		double	ackSnr,
		WifiMode	ackMode,
		double	dataSnr,
		MHz_u	dataChannelWidth,
		uint8_t	dataNss )

privatepure virtual

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 of the DATA we sent
dataNss	the number of spatial streams used to send the DATA

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportDataOk().

Here is the caller graph for this function:

◆ DoReportFinalDataFailed()

virtual void ns3::WifiRemoteStationManager::DoReportFinalDataFailed ( WifiRemoteStation * station )

privatepure virtual

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

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportFinalDataFailed().

Here is the caller graph for this function:

◆ DoReportFinalRtsFailed()

virtual void ns3::WifiRemoteStationManager::DoReportFinalRtsFailed ( WifiRemoteStation * station )

privatepure virtual

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

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportFinalRtsFailed().

Here is the caller graph for this function:

◆ DoReportRtsFailed()

virtual void ns3::WifiRemoteStationManager::DoReportRtsFailed ( WifiRemoteStation * station )

privatepure virtual

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

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportRtsFailed().

Here is the caller graph for this function:

◆ DoReportRtsOk()

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

privatepure virtual

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

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportRtsOk().

Here is the caller graph for this function:

◆ DoReportRxOk()

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

privatepure virtual

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

Implemented in ns3::AarfcdWifiManager, ns3::AarfWifiManager, ns3::AmrrWifiManager, ns3::AparfWifiManager, ns3::ArfWifiManager, ns3::CaraWifiManager, ns3::ConstantRateWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::OnoeWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, ns3::RrpaaWifiManager, and ns3::ThompsonSamplingWifiManager.

Referenced by ReportRxOk().

Here is the caller graph for this function:

◆ DoSetFragmentationThreshold()

void ns3::WifiRemoteStationManager::DoSetFragmentationThreshold ( uint32_t threshold )

private

Actually sets the fragmentation threshold, it also checks the validity of the given threshold.

Parameters

threshold the fragmentation threshold

Definition at line 1264 of file wifi-remote-station-manager.cc.

References m_fragmentationThreshold, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId(), and SetFragmentationThreshold().

Here is the caller graph for this function:

◆ GetAckTxVector()

WifiTxVector ns3::WifiRemoteStationManager::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.

Parameters

to	the MAC address of the Ack receiver
dataTxVector	the TXVECTOR of the Data used by the sender

Returns: TXVECTOR for the Ack

Definition at line 783 of file wifi-remote-station-manager.cc.

References GetControlAnswerMode(), GetDefaultTxPowerLevel(), ns3::WifiPhy::GetDevice(), ns3::GetGuardIntervalForMode(), ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetModulationClass(), ns3::GetPreambleForTransmission(), GetShortPreambleEnabled(), GetStaId(), ns3::WifiPhy::GetTxBandwidth(), ns3::Mac48Address::IsGroup(), m_wifiPhy, NS_ASSERT, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetPreambleType(), and ns3::WifiTxVector::SetTxPowerLevel().

Here is the call graph for this function:

◆ GetAddress()

Mac48Address ns3::WifiRemoteStationManager::GetAddress ( const WifiRemoteStation * station ) const

protected

Return the address of the station.

Parameters

station the station being queried

Returns: the address of the station

Definition at line 1954 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_address, and ns3::WifiRemoteStation::m_state.

◆ GetAffiliatedStaAddress()

std::optional< Mac48Address > ns3::WifiRemoteStationManager::GetAffiliatedStaAddress ( const Mac48Address & mldAddress ) const

Get the address of the remote station operating on this link and affiliated with the MLD having the given MAC address, if any.

Parameters

mldAddress the MLD MAC address

Returns: the address of the remote station operating on this link and affiliated with the MLD, if any

Definition at line 565 of file wifi-remote-station-manager.cc.

References m_states, and NS_ASSERT.

◆ GetAggregation()

bool ns3::WifiRemoteStationManager::GetAggregation ( const WifiRemoteStation * station ) const

protected

Return whether the given station supports A-MPDU.

Parameters

station the station being queried

Returns: true if the station supports MPDU aggregation, false otherwise

Definition at line 1984 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_aggregation, and ns3::WifiRemoteStation::m_state.

Here is the caller graph for this function:

◆ GetAssociationId()

uint16_t ns3::WifiRemoteStationManager::GetAssociationId ( Mac48Address remoteAddress ) const

Get the AID of a remote station.

Should only be called by APs.

Parameters

remoteAddress the MAC address of the remote station

Returns: the Association ID if the station is associated, SU_STA_ID otherwise

Definition at line 502 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::GOT_ASSOC_TX_OK, LookupState(), and ns3::SU_STA_ID.

Referenced by GetStaId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBasicMcs()

WifiMode ns3::WifiRemoteStationManager::GetBasicMcs ( uint8_t i ) const

Return the MCS at the given list index.

Parameters

i	the position in the list

Returns: the basic MCS at the given list index

Definition at line 1849 of file wifi-remote-station-manager.cc.

References NS_ASSERT.

Referenced by GetControlAnswerMode().

Here is the caller graph for this function:

◆ GetBasicMode()

WifiMode ns3::WifiRemoteStationManager::GetBasicMode ( uint8_t i ) const

Return a basic mode from the set of basic modes.

Parameters

i	index of the basic mode in the basic mode set

Returns: the basic mode at the given index

Definition at line 1782 of file wifi-remote-station-manager.cc.

References NS_ASSERT.

Referenced by ns3::IdealWifiManager::DoGetRtsTxVector(), ns3::MinstrelHtWifiManager::DoGetRtsTxVector(), GetControlAnswerMode(), and GetDataTxVector().

Here is the caller graph for this function:

◆ GetBlockAckTxVector()

WifiTxVector ns3::WifiRemoteStationManager::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.

Parameters

to	the MAC address of the BlockAck receiver
dataTxVector	the TXVECTOR of the Data used by the sender

Returns: TXVECTOR for the BlockAck

Definition at line 799 of file wifi-remote-station-manager.cc.

References GetControlAnswerMode(), GetDefaultTxPowerLevel(), ns3::WifiPhy::GetDevice(), ns3::GetGuardIntervalForMode(), ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetModulationClass(), ns3::GetPreambleForTransmission(), GetShortPreambleEnabled(), GetStaId(), ns3::WifiPhy::GetTxBandwidth(), ns3::Mac48Address::IsGroup(), m_wifiPhy, NS_ASSERT, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetPreambleType(), and ns3::WifiTxVector::SetTxPowerLevel().

Here is the call graph for this function:

◆ GetChannelWidth()

MHz_u ns3::WifiRemoteStationManager::GetChannelWidth ( const WifiRemoteStation * station ) const

protected

Return the channel width supported by the station.

Parameters

station the station being queried

Returns: the channel width supported by the station

Definition at line 1960 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_channelWidth, and ns3::WifiRemoteStation::m_state.

Here is the caller graph for this function:

◆ GetChannelWidthSupported()

MHz_u ns3::WifiRemoteStationManager::GetChannelWidthSupported ( Mac48Address address ) const

Return the channel width supported by the station.

Parameters

address the address of the station

Returns: the channel width supported by the station

Definition at line 2097 of file wifi-remote-station-manager.cc.

Referenced by GetDataTxVector().

Here is the caller graph for this function:

◆ GetControlAnswerMode()

WifiMode ns3::WifiRemoteStationManager::GetControlAnswerMode ( WifiMode reqMode ) const

Get control answer mode function.

Parameters

reqMode request mode

Returns: control answer mode

The standard has relatively unambiguous rules for selecting a control response rate (the below is quoted from IEEE 802.11-2012, Section 9.7):

To allow the transmitting STA to calculate the contents of the Duration/ID field, a STA responding to a received frame shall transmit its Control Response frame (either CTS or Ack), other than the BlockAck control frame, at the highest rate in the BSSBasicRateSet parameter that is less than or equal to the rate of the immediately previous frame in the frame exchange sequence (as defined in Annex G) and that is of the same modulation class (see Section 9.7.8) as the received frame...

If no suitable basic rate was found, we search the mandatory rates. The standard (IEEE 802.11-2007, Section 9.6) says:

...If no rate contained in the BSSBasicRateSet parameter meets these conditions, then the control frame sent in response to a received frame shall be transmitted at the highest mandatory rate of the PHY that is less than or equal to the rate of the received frame, and that is of the same modulation class as the received frame. In addition, the Control Response frame shall be sent using the same PHY options as the received frame, unless they conflict with the requirement to use the BSSBasicRateSet parameter.

Todo: Note that we're ignoring the last sentence for now, because there is not yet any manipulation here of PHY options.

If we still haven't found a suitable rate for the response then someone has messed up the simulation configuration. This probably means that the WifiPhyStandard is not set correctly, or that a rate that is not supported by the PHY has been explicitly requested.

Either way, it is serious - we can either disobey the standard or fail, and I have chosen to do the latter...

Definition at line 816 of file wifi-remote-station-manager.cc.

References GetBasicMcs(), GetBasicMode(), GetDefaultMcs(), GetDefaultMode(), ns3::WifiPhy::GetDevice(), ns3::WifiPhy::GetMcsList(), ns3::WifiPhy::GetModeList(), ns3::WifiMode::GetModulationClass(), GetNBasicMcs(), GetNBasicModes(), ns3::IsAllowedControlAnswerModulationClass(), ns3::WifiMode::IsHigherDataRate(), m_wifiPhy, NS_FATAL_ERROR, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by GetAckTxVector(), GetBlockAckTxVector(), and GetCtsTxVector().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCtsToSelfTxVector()

WifiTxVector ns3::WifiRemoteStationManager::GetCtsToSelfTxVector ( )

Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote station manager.

Returns: the transmission mode to use to send the CTS-to-self prior to the transmission of the data packet itself.

Definition at line 653 of file wifi-remote-station-manager.cc.

References GetDefaultMode(), GetDefaultTxPowerLevel(), ns3::WifiPhy::GetDevice(), ns3::GetGuardIntervalForMode(), ns3::WifiMode::GetModulationClass(), GetNumberOfAntennas(), ns3::WifiPhy::GetTxBandwidth(), m_wifiPhy, ns3::WIFI_MOD_CLASS_EHT, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, ns3::WIFI_MOD_CLASS_VHT, ns3::WIFI_PREAMBLE_EHT_MU, ns3::WIFI_PREAMBLE_HE_SU, ns3::WIFI_PREAMBLE_HT_MF, ns3::WIFI_PREAMBLE_LONG, and ns3::WIFI_PREAMBLE_VHT_SU.

Here is the call graph for this function:

◆ GetCtsTxVector()

WifiTxVector ns3::WifiRemoteStationManager::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.

Parameters

to	the MAC address of the CTS receiver
rtsTxMode	the mode of the RTS used by the sender

Returns: TXVECTOR for the CTS

Definition at line 734 of file wifi-remote-station-manager.cc.

References GetControlAnswerMode(), GetDefaultTxPowerLevel(), ns3::WifiPhy::GetDevice(), ns3::GetGuardIntervalForMode(), ns3::WifiMode::GetModulationClass(), ns3::GetPreambleForTransmission(), GetShortPreambleEnabled(), ns3::WifiPhy::GetTxBandwidth(), ns3::Mac48Address::IsGroup(), m_wifiPhy, NS_ASSERT, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetPreambleType(), and ns3::WifiTxVector::SetTxPowerLevel().

Here is the call graph for this function:

◆ GetDataTxVector()

WifiTxVector ns3::WifiRemoteStationManager::GetDataTxVector	(	const WifiMacHeader &	header,
		MHz_u	allowedWidth )

Parameters

header	MAC header
allowedWidth	the allowed width to send this packet

Returns: the TXVECTOR to use to send this packet

Definition at line 580 of file wifi-remote-station-manager.cc.

Here is the call graph for this function:

◆ GetDefaultMcs()

WifiMode ns3::WifiRemoteStationManager::GetDefaultMcs ( ) const

Return the default Modulation and Coding Scheme (MCS) index.

Returns: the default WifiMode

Definition at line 1710 of file wifi-remote-station-manager.cc.

Referenced by GetControlAnswerMode(), and LookupState().

Here is the caller graph for this function:

◆ GetDefaultMode()

WifiMode ns3::WifiRemoteStationManager::GetDefaultMode ( ) const

Return the default transmission mode.

Returns: WifiMode the default transmission mode

Definition at line 1701 of file wifi-remote-station-manager.cc.

References NS_ASSERT.

Referenced by ns3::IdealWifiManager::DoGetRtsTxVector(), GetControlAnswerMode(), GetCtsToSelfTxVector(), GetDataTxVector(), LookupState(), and ns3::IdealWifiManager::Reset().

Here is the caller graph for this function:

◆ GetDefaultModeForSta()

WifiMode ns3::WifiRemoteStationManager::GetDefaultModeForSta ( const WifiRemoteStation * st ) const

Return the default MCS to use to transmit frames to the given station.

Parameters

st	the given station

Returns: the default MCS to use to transmit frames to the given station

Definition at line 1716 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_address, ns3::WifiRemoteStation::m_state, NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Referenced by ns3::IdealWifiManager::DoGetDataTxVector().

Here is the caller graph for this function:

◆ GetDefaultTxPowerLevel()

uint8_t ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel ( ) const

Returns: the default transmission power

Definition at line 1373 of file wifi-remote-station-manager.cc.

References m_defaultTxPowerLevel.

Here is the caller graph for this function:

◆ GetDsssSupported()

bool ns3::WifiRemoteStationManager::GetDsssSupported ( const Mac48Address & address ) const

Return whether the station supports DSSS or not.

Parameters

address the address of the station

Returns: true if DSSS is supported by the station, false otherwise

Definition at line 2133 of file wifi-remote-station-manager.cc.

◆ GetEhtSupported() [1/3]

bool ns3::WifiRemoteStationManager::GetEhtSupported ( ) const

Return whether the device has EHT capability support enabled.

Returns: true if EHT capability support is enabled, false otherwise

Definition at line 264 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), and m_wifiPhy.

Referenced by ns3::IdealWifiManager::IsCandidateModulationClass(), and ns3::IdealWifiManager::IsModulationClassSupported().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEhtSupported() [2/3]

bool ns3::WifiRemoteStationManager::GetEhtSupported ( const WifiRemoteStation * station ) const

protected

Return whether the given station is EHT capable.

Parameters

station the station being queried

Returns: true if the station has EHT capabilities, false otherwise

Definition at line 2054 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_ehtCapabilities, and ns3::WifiRemoteStation::m_state.

◆ GetEhtSupported() [3/3]

bool ns3::WifiRemoteStationManager::GetEhtSupported ( Mac48Address address ) const

Return whether the station supports EHT or not.

Parameters

address the address of the station

Returns: true if EHT is supported by the station, false otherwise

Definition at line 2169 of file wifi-remote-station-manager.cc.

◆ GetEmlsrEnabled() [1/2]

bool ns3::WifiRemoteStationManager::GetEmlsrEnabled ( const Mac48Address & address ) const

Parameters

address the (MLD or link) address of the non-AP MLD

Returns: whether EMLSR mode is enabled for the non-AP MLD on this link

Definition at line 2183 of file wifi-remote-station-manager.cc.

◆ GetEmlsrEnabled() [2/2]

bool ns3::WifiRemoteStationManager::GetEmlsrEnabled ( const WifiRemoteStation * station ) const

protected

Parameters

station the station of a non-AP MLD

Returns: whether EMLSR mode is enabled for the non-AP MLD on this link

Definition at line 2068 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_emlsrEnabled, and ns3::WifiRemoteStation::m_state.

◆ GetEmlsrSupported() [1/2]

bool ns3::WifiRemoteStationManager::GetEmlsrSupported ( const Mac48Address & address ) const

Parameters

address the (MLD or link) address of the non-AP MLD

Returns: whether the non-AP MLD supports EMLSR

Definition at line 2175 of file wifi-remote-station-manager.cc.

◆ GetEmlsrSupported() [2/2]

bool ns3::WifiRemoteStationManager::GetEmlsrSupported ( const WifiRemoteStation * station ) const

protected

Parameters

station the station of a non-AP MLD

Returns: whether the non-AP MLD supports EMLSR

Definition at line 2060 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_mleCommonInfo, and ns3::WifiRemoteStation::m_state.

◆ GetErpOfdmSupported()

bool ns3::WifiRemoteStationManager::GetErpOfdmSupported ( const Mac48Address & address ) const

Return whether the station supports ERP OFDM or not.

Parameters

address the address of the station

Returns: true if ERP OFDM is supported by the station, false otherwise

Definition at line 2139 of file wifi-remote-station-manager.cc.

◆ GetFragmentationThreshold()

uint32_t ns3::WifiRemoteStationManager::GetFragmentationThreshold ( ) const

Return the fragmentation threshold.

Returns: the fragmentation threshold

Definition at line 304 of file wifi-remote-station-manager.cc.

References DoGetFragmentationThreshold().

Referenced by GetFragmentOffset(), GetFragmentSize(), GetNFragments(), and NeedFragmentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFragmentOffset()

uint32_t ns3::WifiRemoteStationManager::GetFragmentOffset	(	Ptr< const WifiMpdu >	mpdu,
		uint32_t	fragmentNumber )

Parameters

mpdu	the packet to send
fragmentNumber	the fragment index of the next fragment to send (starts at zero).

Returns: the offset within the original packet where this fragment starts.

Definition at line 1351 of file wifi-remote-station-manager.cc.

References GetFragmentationThreshold(), GetNFragments(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::WIFI_MAC_FCS_LENGTH.

Here is the call graph for this function:

◆ GetFragmentSize()

uint32_t ns3::WifiRemoteStationManager::GetFragmentSize	(	Ptr< const WifiMpdu >	mpdu,
		uint32_t	fragmentNumber )

Parameters

mpdu	the MPDU to send
fragmentNumber	the fragment index of the next fragment to send (starts at zero).

Returns: the size of the corresponding fragment.

Definition at line 1320 of file wifi-remote-station-manager.cc.

References GetFragmentationThreshold(), GetNFragments(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::WIFI_MAC_FCS_LENGTH.

Here is the call graph for this function:

◆ GetGuardInterval() [1/2]

Time ns3::WifiRemoteStationManager::GetGuardInterval ( ) const

Return the supported HE guard interval duration.

Returns: the supported HE guard interval duration

Definition at line 290 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), GetHeSupported(), m_wifiPhy, and NS_ASSERT.

Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), ns3::ConstantRateWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), ns3::ConstantRateWifiManager::DoGetRtsTxVector(), ns3::MinstrelHtWifiManager::DoInitialize(), ns3::ThompsonSamplingWifiManager::GetModeGuardInterval(), LookupState(), and ns3::MinstrelHtWifiManager::RateInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGuardInterval() [2/2]

Time ns3::WifiRemoteStationManager::GetGuardInterval ( const WifiRemoteStation * station ) const

protected

Return the HE guard interval duration supported by the station.

Parameters

station the station being queried

Returns: the HE guard interval duration supported by the station

Definition at line 1978 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_guardInterval, and ns3::WifiRemoteStation::m_state.

◆ GetHeSupported() [1/3]

bool ns3::WifiRemoteStationManager::GetHeSupported ( ) const

Return whether the device has HE capability support enabled.

Returns: true if HE capability support is enabled, false otherwise

Definition at line 258 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), and m_wifiPhy.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeSupported() [2/3]

bool ns3::WifiRemoteStationManager::GetHeSupported ( const WifiRemoteStation * station ) const

protected

Return whether the given station is HE capable.

Parameters

station the station being queried

Returns: true if the station has HE capabilities, false otherwise

Definition at line 2048 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_heCapabilities, and ns3::WifiRemoteStation::m_state.

◆ GetHeSupported() [3/3]

bool ns3::WifiRemoteStationManager::GetHeSupported ( Mac48Address address ) const

Return whether the station supports HE or not.

Parameters

address the address of the station

Returns: true if HE is supported by the station, false otherwise

Definition at line 2163 of file wifi-remote-station-manager.cc.

◆ GetHtSupported() [1/3]

bool ns3::WifiRemoteStationManager::GetHtSupported ( ) const

Return whether the device has HT capability support enabled on the link this manager is associated with.

Note that this means that this function returns false if this is a 6 GHz link.

Returns: true if HT capability support is enabled, false otherwise

Definition at line 243 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), ns3::WifiPhy::GetPhyBand(), m_wifiPhy, and ns3::WIFI_PHY_BAND_6GHZ.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHtSupported() [2/3]

bool ns3::WifiRemoteStationManager::GetHtSupported ( const WifiRemoteStation * station ) const

protected

Return whether the given station is HT capable.

Parameters

station the station being queried

Returns: true if the station has HT capabilities, false otherwise

Definition at line 2036 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_htCapabilities, and ns3::WifiRemoteStation::m_state.

◆ GetHtSupported() [3/3]

bool ns3::WifiRemoteStationManager::GetHtSupported ( Mac48Address address ) const

Return whether the station supports HT or not.

Parameters

address the address of the station

Returns: true if HT is supported by the station, false otherwise

Definition at line 2151 of file wifi-remote-station-manager.cc.

◆ GetInfo()

WifiRemoteStationInfo ns3::WifiRemoteStationManager::GetInfo ( Mac48Address address )

Parameters

address of the remote station

Returns: information regarding the remote station associated with the given address

Definition at line 1379 of file wifi-remote-station-manager.cc.

References LookupState().

Here is the call graph for this function:

◆ GetLdpcSupported() [1/2]

bool ns3::WifiRemoteStationManager::GetLdpcSupported ( ) const

Return whether the device has LDPC support enabled.

Returns: true if LDPC support is enabled, false otherwise

Definition at line 270 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), and m_wifiPhy.

Here is the call graph for this function:

◆ GetLdpcSupported() [2/2]

bool ns3::WifiRemoteStationManager::GetLdpcSupported ( Mac48Address address ) const

Return whether the station supports LDPC or not.

Parameters

address the address of the station

Returns: true if LDPC is supported by the station, false otherwise

Definition at line 1679 of file wifi-remote-station-manager.cc.

◆ GetMac()

Ptr< WifiMac > ns3::WifiRemoteStationManager::GetMac ( ) const

Return the WifiMac.

Returns: a pointer to the WifiMac

Definition at line 2018 of file wifi-remote-station-manager.cc.

◆ GetMaxNumberOfTransmitStreams()

uint8_t ns3::WifiRemoteStationManager::GetMaxNumberOfTransmitStreams ( ) const

Returns: the maximum number of spatial streams supported by the PHY layer

Definition at line 2205 of file wifi-remote-station-manager.cc.

Referenced by ns3::ConstantRateWifiManager::DoGetDataTxVector(), and ns3::IdealWifiManager::DoGetDataTxVector().

Here is the caller graph for this function:

◆ GetMcsSupported()

WifiMode ns3::WifiRemoteStationManager::GetMcsSupported	(	const WifiRemoteStation *	station,
		uint8_t	i ) const

protected

Return the WifiMode supported by the specified station at the specified index.

Parameters

station	the station being queried
i	the index

Returns: the WifiMode at the given index of the specified station

Definition at line 1917 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_operationalMcsSet, ns3::WifiRemoteStation::m_state, and NS_ASSERT.

Referenced by ns3::MinstrelHtWifiManager::CalculateRetransmits(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetRtsTxVector(), ns3::MinstrelHtWifiManager::RateInit(), ns3::MinstrelHtWifiManager::StatsDump(), and ns3::MinstrelHtWifiManager::UpdateStats().

Here is the caller graph for this function:

◆ GetMldAddress()

std::optional< Mac48Address > ns3::WifiRemoteStationManager::GetMldAddress ( const Mac48Address & address ) const

Get the address of the MLD the given station is affiliated with, if any.

Note that an MLD address is only present if an ML discovery/setup was performed with the given station (which requires both this station and the given station to be MLDs).

Parameters

address the MAC address of the remote station

Returns: the address of the MLD the given station is affiliated with, if any

Definition at line 553 of file wifi-remote-station-manager.cc.

References m_states.

◆ GetMostRecentRssi()

std::optional< dBm_u > ns3::WifiRemoteStationManager::GetMostRecentRssi ( Mac48Address address ) const

Parameters

address of the remote station

Returns: the RSSI of the most recent packet received from the remote station (irrespective of TID)

This method is typically used when the device needs to estimate the target UL RSSI info to put in the Trigger frame to send to the remote station.

Definition at line 1385 of file wifi-remote-station-manager.cc.

References Lookup().

Here is the call graph for this function:

◆ GetNBasicMcs()

uint8_t ns3::WifiRemoteStationManager::GetNBasicMcs ( ) const

Return the number of basic MCS index.

Returns: the number of basic MCS index

Definition at line 1843 of file wifi-remote-station-manager.cc.

Referenced by GetControlAnswerMode().

Here is the caller graph for this function:

◆ GetNBasicModes()

uint8_t ns3::WifiRemoteStationManager::GetNBasicModes ( ) const

Return the number of basic modes we support.

Returns: the number of basic modes we support

Definition at line 1776 of file wifi-remote-station-manager.cc.

Referenced by ns3::IdealWifiManager::DoGetRtsTxVector(), ns3::MinstrelHtWifiManager::DoGetRtsTxVector(), GetControlAnswerMode(), and GetDataTxVector().

Here is the caller graph for this function:

◆ GetNess()

uint8_t ns3::WifiRemoteStationManager::GetNess ( const WifiRemoteStation * station ) const

protected

Returns: the number of Ness the station has.

Parameters

station the station being queried

Returns: the number of Ness the station has

Definition at line 2006 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_ness, and ns3::WifiRemoteStation::m_state.

Referenced by ns3::MinstrelHtWifiManager::DoGetDataTxVector().

Here is the caller graph for this function:

◆ GetNFragments()

uint32_t ns3::WifiRemoteStationManager::GetNFragments ( Ptr< const WifiMpdu > mpdu )

private

Return the number of fragments needed for the given packet.

Parameters

mpdu	the packet to be fragmented

Returns: the number of fragments needed

Definition at line 1301 of file wifi-remote-station-manager.cc.

References GetFragmentationThreshold(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::WIFI_MAC_FCS_LENGTH.

Referenced by GetFragmentOffset(), GetFragmentSize(), and IsLastFragment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNMcsSupported() [1/2]

uint8_t ns3::WifiRemoteStationManager::GetNMcsSupported ( const WifiRemoteStation * station ) const

protected

Return the number of MCS supported by the given station.

Parameters

station the station being queried

Returns: the number of MCS supported by the given station

Definition at line 2074 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_operationalMcsSet, and ns3::WifiRemoteStation::m_state.

◆ GetNMcsSupported() [2/2]

uint8_t ns3::WifiRemoteStationManager::GetNMcsSupported ( Mac48Address address ) const

Return the number of MCS supported by the station.

Parameters

address the address of the station

Returns: the number of MCS supported by the station

Definition at line 2127 of file wifi-remote-station-manager.cc.

Referenced by ns3::MinstrelHtWifiManager::CheckInit(), and ns3::IdealWifiManager::DoGetDataTxVector().

Here is the caller graph for this function:

◆ GetNNonErpBasicModes()

uint32_t ns3::WifiRemoteStationManager::GetNNonErpBasicModes ( ) const

Return the number of non-ERP basic modes we support.

Returns: the number of basic modes we support

Definition at line 1789 of file wifi-remote-station-manager.cc.

References ns3::WIFI_MOD_CLASS_ERP_OFDM.

◆ GetNNonErpSupported()

uint32_t ns3::WifiRemoteStationManager::GetNNonErpSupported ( const WifiRemoteStation * station ) const

protected

Return the number of non-ERP modes supported by the given station.

Parameters

station the station being queried

Returns: the number of non-ERP modes supported by the given station

Definition at line 2080 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_operationalRateSet, ns3::WifiRemoteStation::m_state, and ns3::WIFI_MOD_CLASS_ERP_OFDM.

◆ GetNonErpBasicMode()

WifiMode ns3::WifiRemoteStationManager::GetNonErpBasicMode ( uint8_t i ) const

Return a basic mode from the set of basic modes that is not an ERP mode.

Parameters

i	index of the basic mode in the basic mode set

Returns: the basic mode at the given index

Definition at line 1804 of file wifi-remote-station-manager.cc.

References NS_ASSERT, and ns3::WIFI_MOD_CLASS_ERP_OFDM.

◆ GetNonErpSupported()

WifiMode ns3::WifiRemoteStationManager::GetNonErpSupported	(	const WifiRemoteStation *	station,
		uint8_t	i ) const

protected

Return whether non-ERP mode associated with the specified station at the specified index.

Parameters

station	the station being queried
i	the index

Returns: WifiMode at the given index of the specified station

Definition at line 1924 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_operationalRateSet, ns3::WifiRemoteStation::m_state, NS_ASSERT, and ns3::WIFI_MOD_CLASS_ERP_OFDM.

Referenced by ns3::AarfcdWifiManager::DoGetRtsTxVector(), ns3::AarfWifiManager::DoGetRtsTxVector(), ns3::AmrrWifiManager::DoGetRtsTxVector(), ns3::AparfWifiManager::DoGetRtsTxVector(), ns3::ArfWifiManager::DoGetRtsTxVector(), ns3::CaraWifiManager::DoGetRtsTxVector(), ns3::OnoeWifiManager::DoGetRtsTxVector(), ns3::ParfWifiManager::DoGetRtsTxVector(), ns3::RraaWifiManager::DoGetRtsTxVector(), ns3::RrpaaWifiManager::DoGetRtsTxVector(), and ns3::MinstrelWifiManager::GetRtsTxVector().

Here is the caller graph for this function:

◆ GetNonUnicastMode()

WifiMode ns3::WifiRemoteStationManager::GetNonUnicastMode ( ) const

Return a mode for non-unicast packets.

Returns: WifiMode for non-unicast packets

Definition at line 1856 of file wifi-remote-station-manager.cc.

Referenced by GetDataTxVector(), and GetRtsTxVector().

Here is the caller graph for this function:

◆ GetNSupported()

uint8_t ns3::WifiRemoteStationManager::GetNSupported ( const WifiRemoteStation * station ) const

protected

Return the number of modes supported by the given station.

Parameters

station the station being queried

Returns: the number of modes supported by the given station

Definition at line 2024 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_operationalRateSet, and ns3::WifiRemoteStation::m_state.

Referenced by ns3::AparfWifiManager::CheckInit(), ns3::MinstrelWifiManager::CheckInit(), ns3::ParfWifiManager::CheckInit(), ns3::RraaWifiManager::CheckInit(), ns3::RrpaaWifiManager::CheckInit(), ns3::AmrrWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::OnoeWifiManager::DoGetDataTxVector(), ns3::AarfcdWifiManager::DoReportDataOk(), ns3::AarfWifiManager::DoReportDataOk(), ns3::CaraWifiManager::DoReportDataOk(), ns3::AmrrWifiManager::IncreaseRate(), ns3::ThompsonSamplingWifiManager::InitializeStation(), ns3::AmrrWifiManager::IsMaxRate(), ns3::AmrrWifiManager::UpdateMode(), and ns3::OnoeWifiManager::UpdateMode().

Here is the caller graph for this function:

◆ GetNumberOfAntennas()

uint8_t ns3::WifiRemoteStationManager::GetNumberOfAntennas ( ) const

Returns: the number of antennas supported by the PHY layer

Definition at line 2199 of file wifi-remote-station-manager.cc.

Referenced by ns3::ConstantRateWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), ns3::ThompsonSamplingWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetRtsTxVector(), ns3::ThompsonSamplingWifiManager::DoGetRtsTxVector(), GetCtsToSelfTxVector(), GetDataTxVector(), and GetRtsTxVector().

Here is the caller graph for this function:

◆ GetNumberOfSupportedStreams() [1/2]

uint8_t ns3::WifiRemoteStationManager::GetNumberOfSupportedStreams ( const WifiRemoteStation * station ) const

protected

Return the number of supported streams the station has.

Parameters

station the station being queried

Returns: the number of supported streams the station has

Definition at line 1990 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_heCapabilities, ns3::WifiRemoteStationState::m_htCapabilities, and ns3::WifiRemoteStation::m_state.

◆ GetNumberOfSupportedStreams() [2/2]

uint8_t ns3::WifiRemoteStationManager::GetNumberOfSupportedStreams ( Mac48Address address ) const

Return the number of spatial streams supported by the station.

Parameters

address the address of the station

Returns: the number of spatial streams supported by the station

Definition at line 2115 of file wifi-remote-station-manager.cc.

Referenced by ns3::ConstantRateWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), and ns3::MinstrelHtWifiManager::RateInit().

Here is the caller graph for this function:

◆ GetOfdmSupported()

bool ns3::WifiRemoteStationManager::GetOfdmSupported ( const Mac48Address & address ) const

Return whether the station supports OFDM or not.

Parameters

address the address of the station

Returns: true if OFDM is supported by the station, false otherwise

Definition at line 2145 of file wifi-remote-station-manager.cc.

◆ GetPhy()

Ptr< WifiPhy > ns3::WifiRemoteStationManager::GetPhy ( ) const

Return the WifiPhy.

Returns: a pointer to the WifiPhy

Definition at line 2012 of file wifi-remote-station-manager.cc.

Here is the caller graph for this function:

◆ GetQosSupported() [1/2]

bool ns3::WifiRemoteStationManager::GetQosSupported ( const WifiRemoteStation * station ) const

protected

Return whether the given station is QoS capable.

Parameters

station the station being queried

Returns: true if the station has QoS capabilities, false otherwise

Definition at line 2030 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_qosSupported, and ns3::WifiRemoteStation::m_state.

◆ GetQosSupported() [2/2]

bool ns3::WifiRemoteStationManager::GetQosSupported ( Mac48Address address ) const

Return whether the given station is QoS capable.

Parameters

address the address of the station

Returns: true if the station has QoS capabilities, false otherwise

Definition at line 421 of file wifi-remote-station-manager.cc.

References LookupState().

Here is the call graph for this function:

◆ GetRtsTxVector()

WifiTxVector ns3::WifiRemoteStationManager::GetRtsTxVector	(	Mac48Address	address,
		MHz_u	allowedWidth )

Parameters

address	remote address
allowedWidth	the allowed width for the data frame being protected

Returns: the TXVECTOR to use to send the RTS prior to the transmission of the data packet itself.

Definition at line 690 of file wifi-remote-station-manager.cc.

Here is the call graph for this function:

◆ GetShortGuardIntervalSupported() [1/3]

bool ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported ( ) const

Return whether the device has SGI support enabled.

Returns: true if SGI support is enabled, false otherwise

Definition at line 280 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), and m_wifiPhy.

Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), ns3::ConstantRateWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), ns3::ConstantRateWifiManager::DoGetRtsTxVector(), ns3::MinstrelHtWifiManager::DoInitialize(), ns3::ThompsonSamplingWifiManager::GetModeGuardInterval(), and ns3::MinstrelHtWifiManager::RateInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetShortGuardIntervalSupported() [2/3]

bool ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported ( const WifiRemoteStation * station ) const

protected

Return whether the given station supports HT/VHT short guard interval.

Parameters

station the station being queried

Returns: true if the station supports HT/VHT short guard interval, false otherwise

Definition at line 1966 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_htCapabilities, and ns3::WifiRemoteStation::m_state.

◆ GetShortGuardIntervalSupported() [3/3]

bool ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported ( Mac48Address address ) const

Return whether the station supports HT/VHT short guard interval.

Parameters

address the address of the station

Returns: true if the station supports HT/VHT short guard interval, false otherwise

Definition at line 2103 of file wifi-remote-station-manager.cc.

◆ GetShortPreambleEnabled()

bool ns3::WifiRemoteStationManager::GetShortPreambleEnabled ( ) const

Return whether the device uses short PHY preambles.

Returns: true if short PHY preambles are enabled, false otherwise

Definition at line 237 of file wifi-remote-station-manager.cc.

References m_shortPreambleEnabled.

Here is the caller graph for this function:

◆ GetShortPreambleSupported()

bool ns3::WifiRemoteStationManager::GetShortPreambleSupported ( Mac48Address address ) const

Return whether the station supports short PHY preamble or not.

Parameters

address the address of the station

Returns: true if short PHY preamble is supported by the station, false otherwise

Definition at line 409 of file wifi-remote-station-manager.cc.

References LookupState().

Here is the call graph for this function:

◆ GetShortSlotTimeEnabled()

bool ns3::WifiRemoteStationManager::GetShortSlotTimeEnabled ( ) const

Return whether the device uses short slot time.

Returns: true if short slot time is enabled, false otherwise

Definition at line 231 of file wifi-remote-station-manager.cc.

References m_shortSlotTimeEnabled.

◆ GetShortSlotTimeSupported()

bool ns3::WifiRemoteStationManager::GetShortSlotTimeSupported ( Mac48Address address ) const

Return whether the station supports short ERP slot time or not.

Parameters

address the address of the station

Returns: true if short ERP slot time is supported by the station, false otherwise

Definition at line 415 of file wifi-remote-station-manager.cc.

References LookupState().

Here is the call graph for this function:

◆ GetStaId()

uint16_t ns3::WifiRemoteStationManager::GetStaId	(	Mac48Address	address,
		const WifiTxVector &	txVector ) const

private

If the given TXVECTOR is used for a MU transmission, return the STAID of the station with the given address if we are an AP or our own STAID if we are a STA associated with some AP.

Otherwise, return SU_STA_ID.

Parameters

address	the address of the station
txVector	the TXVECTOR used for a MU transmission

Returns: the STA-ID of the station

Definition at line 514 of file wifi-remote-station-manager.cc.

References ns3::AP, GetAssociationId(), ns3::WifiTxVector::IsMu(), m_wifiMac, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::STA, ns3::StaticCast(), and ns3::SU_STA_ID.

Referenced by GetAckTxVector(), GetBlockAckTxVector(), ReportAmpduTxStatus(), ReportDataOk(), and ReportRxOk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStationEhtCapabilities()

Ptr< const EhtCapabilities > ns3::WifiRemoteStationManager::GetStationEhtCapabilities ( Mac48Address from )

Return the EHT capabilities sent by the remote station.

Parameters

from	the address of the remote station

Returns: the EHT capabilities sent by the remote station

Definition at line 1651 of file wifi-remote-station-manager.cc.

◆ GetStationEmlCapabilities()

std::optional< std::reference_wrapper< CommonInfoBasicMle::EmlCapabilities > > ns3::WifiRemoteStationManager::GetStationEmlCapabilities ( const Mac48Address & from )

Parameters

from	the (MLD or link) address of the remote non-AP MLD

Returns: the EML Capabilities advertised by the remote non-AP MLD

Definition at line 1657 of file wifi-remote-station-manager.cc.

◆ GetStationHe6GhzCapabilities()

Ptr< const He6GhzBandCapabilities > ns3::WifiRemoteStationManager::GetStationHe6GhzCapabilities ( const Mac48Address & from ) const

Return the HE 6 GHz Band Capabilities sent by a remote station.

Parameters

from	the address of the remote station

Returns: the HE 6 GHz Band capabilities sent by the remote station

Definition at line 1645 of file wifi-remote-station-manager.cc.

Referenced by ns3::MinstrelHtWifiManager::CheckInit(), and ns3::IdealWifiManager::DoGetDataTxVector().

Here is the caller graph for this function:

◆ GetStationHeCapabilities()

Ptr< const HeCapabilities > ns3::WifiRemoteStationManager::GetStationHeCapabilities ( Mac48Address from )

Return the HE capabilities sent by the remote station.

Parameters

from	the address of the remote station

Returns: the HE capabilities sent by the remote station

Definition at line 1639 of file wifi-remote-station-manager.cc.

◆ GetStationHtCapabilities()

Ptr< const HtCapabilities > ns3::WifiRemoteStationManager::GetStationHtCapabilities ( Mac48Address from )

Return the HT capabilities sent by the remote station.

Parameters

from	the address of the remote station

Returns: the HT capabilities sent by the remote station

Definition at line 1627 of file wifi-remote-station-manager.cc.

◆ GetStationMldCapabilities()

std::optional< std::reference_wrapper< CommonInfoBasicMle::MldCapabilities > > ns3::WifiRemoteStationManager::GetStationMldCapabilities ( const Mac48Address & from )

Parameters

from	the (MLD or link) address of the remote non-AP MLD

Returns: the MLD Capabilities advertised by the remote non-AP MLD

Definition at line 1668 of file wifi-remote-station-manager.cc.

◆ GetStationVhtCapabilities()

Ptr< const VhtCapabilities > ns3::WifiRemoteStationManager::GetStationVhtCapabilities ( Mac48Address from )

Return the VHT capabilities sent by the remote station.

Parameters

from	the address of the remote station

Returns: the VHT capabilities sent by the remote station

Definition at line 1633 of file wifi-remote-station-manager.cc.

◆ GetSupported()

WifiMode ns3::WifiRemoteStationManager::GetSupported	(	const WifiRemoteStation *	station,
		uint8_t	i ) const

protected

Return whether mode associated with the specified station at the specified index.

Parameters

station	the station being queried
i	the index

Returns: WifiMode at the given index of the specified station

Definition at line 1910 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::m_operationalRateSet, ns3::WifiRemoteStation::m_state, and NS_ASSERT.

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::WifiRemoteStationManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 40 of file wifi-remote-station-manager.cc.

References CTS_TO_SELF, DoGetFragmentationThreshold(), DoSetFragmentationThreshold(), m_defaultTxPowerLevel, m_erpProtectionMode, m_htProtectionMode, m_macTxDataFailed, m_macTxFinalDataFailed, m_macTxFinalRtsFailed, m_macTxRtsFailed, m_nonUnicastMode, m_rtsCtsTxDurationThresh, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::MakeWifiModeAccessor(), ns3::MakeWifiModeChecker(), RTS_CTS, SetMaxSlrc(), SetMaxSsrc(), ns3::TypeId::SetParent(), and SetRtsCtsThreshold().

Referenced by WifiTxopTest::CheckResults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUseNonErpProtection()

bool ns3::WifiRemoteStationManager::GetUseNonErpProtection ( ) const

Return whether the device supports protection of non-ERP stations.

Returns: true if protection for non-ERP stations is enabled, false otherwise

Definition at line 1205 of file wifi-remote-station-manager.cc.

References m_useNonErpProtection.

Referenced by ns3::AarfcdWifiManager::DoGetRtsTxVector(), ns3::AarfWifiManager::DoGetRtsTxVector(), ns3::AmrrWifiManager::DoGetRtsTxVector(), ns3::AparfWifiManager::DoGetRtsTxVector(), ns3::ArfWifiManager::DoGetRtsTxVector(), ns3::CaraWifiManager::DoGetRtsTxVector(), ns3::OnoeWifiManager::DoGetRtsTxVector(), ns3::ParfWifiManager::DoGetRtsTxVector(), ns3::RraaWifiManager::DoGetRtsTxVector(), ns3::RrpaaWifiManager::DoGetRtsTxVector(), and ns3::MinstrelWifiManager::GetRtsTxVector().

Here is the caller graph for this function:

◆ GetUseNonHtProtection()

bool ns3::WifiRemoteStationManager::GetUseNonHtProtection ( ) const

Return whether the device supports protection of non-HT stations.

Returns: true if protection for non-HT stations is enabled, false otherwise

Definition at line 1218 of file wifi-remote-station-manager.cc.

References m_useNonHtProtection.

◆ GetVhtSupported() [1/3]

bool ns3::WifiRemoteStationManager::GetVhtSupported ( ) const

Return whether the device has VHT capability support enabled on the link this manager is associated with.

Note that this means that this function returns false if this is a 2.4 or 6 GHz link.

Returns: true if VHT capability support is enabled, false otherwise

Definition at line 250 of file wifi-remote-station-manager.cc.

References ns3::WifiPhy::GetDevice(), ns3::WifiPhy::GetPhyBand(), m_wifiPhy, ns3::WIFI_PHY_BAND_2_4GHZ, and ns3::WIFI_PHY_BAND_6GHZ.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVhtSupported() [2/3]

bool ns3::WifiRemoteStationManager::GetVhtSupported ( const WifiRemoteStation * station ) const

protected

Return whether the given station is VHT capable.

Parameters

station the station being queried

Returns: true if the station has VHT capabilities, false otherwise

Definition at line 2042 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStation::m_state, and ns3::WifiRemoteStationState::m_vhtCapabilities.

◆ GetVhtSupported() [3/3]

bool ns3::WifiRemoteStationManager::GetVhtSupported ( Mac48Address address ) const

Return whether the station supports VHT or not.

Parameters

address the address of the station

Returns: true if VHT is supported by the station, false otherwise

Definition at line 2157 of file wifi-remote-station-manager.cc.

◆ IsAssociated()

bool ns3::WifiRemoteStationManager::IsAssociated ( Mac48Address address ) const

Return whether the station associated.

Parameters

address the address of the station

Returns: true if the station is associated, false otherwise

Definition at line 437 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::GOT_ASSOC_TX_OK, and LookupState().

Here is the call graph for this function:

◆ IsAssocRefused()

bool ns3::WifiRemoteStationManager::IsAssocRefused ( Mac48Address address ) const

Return whether we refused an association request from the given station.

Parameters

address the address of the station

Returns: true if we refused an association request, false otherwise

Definition at line 485 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::ASSOC_REFUSED, and LookupState().

Here is the call graph for this function:

◆ IsBrandNew()

bool ns3::WifiRemoteStationManager::IsBrandNew ( Mac48Address address ) const

Return whether the station state is brand new.

Parameters

address the address of the station

Returns: true if the state of the station is brand new, false otherwise

Definition at line 427 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::BRAND_NEW, and LookupState().

Here is the call graph for this function:

◆ IsInPsMode()

bool ns3::WifiRemoteStationManager::IsInPsMode ( const Mac48Address & address ) const

Return whether the STA is currently in Power Save mode.

Parameters

address the address of the station

Returns: true if the station is in Power Save mode, false otherwise

Definition at line 541 of file wifi-remote-station-manager.cc.

References LookupState().

Here is the call graph for this function:

◆ IsLastFragment()

bool ns3::WifiRemoteStationManager::IsLastFragment	(	Ptr< const WifiMpdu >	mpdu,
		uint32_t	fragmentNumber )

Parameters

mpdu	the packet to send
fragmentNumber	the fragment index of the next fragment to send (starts at zero).

Returns: true if this is the last fragment, false otherwise.

Definition at line 1363 of file wifi-remote-station-manager.cc.

References GetNFragments(), NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ IsWaitAssocTxOk()

bool ns3::WifiRemoteStationManager::IsWaitAssocTxOk ( Mac48Address address ) const

Return whether we are waiting for an ACK for the association response we sent.

Parameters

address the address of the station

Returns: true if the station is associated, false otherwise

Definition at line 447 of file wifi-remote-station-manager.cc.

References LookupState(), and ns3::WifiRemoteStationState::WAIT_ASSOC_TX_OK.

Here is the call graph for this function:

◆ Lookup()

WifiRemoteStation * ns3::WifiRemoteStationManager::Lookup ( Mac48Address address ) const

private

Return the station associated with the given address.

Parameters

address the address of the station

Returns: WifiRemoteStation corresponding to the address

Definition at line 1436 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStation::m_rssiAndUpdateTimePair, ns3::WifiRemoteStation::m_state, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Seconds().

Referenced by GetDataTxVector(), GetMostRecentRssi(), GetRtsTxVector(), NeedFragmentation(), NeedRetransmission(), NeedRts(), ReportAmpduTxStatus(), ReportDataFailed(), ReportDataOk(), ReportFinalDataFailed(), ReportFinalRtsFailed(), ReportRtsFailed(), ReportRtsOk(), and ReportRxOk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupState()

std::shared_ptr< WifiRemoteStationState > ns3::WifiRemoteStationManager::LookupState ( Mac48Address address ) const

private

Return the state of the station associated with the given address.

Parameters

address the address of the station

Returns: WifiRemoteStationState corresponding to the address

Definition at line 1398 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::BRAND_NEW, ns3::WifiPhy::GetChannelWidth(), GetDefaultMcs(), GetDefaultMode(), GetGuardInterval(), m_states, m_wifiPhy, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by AddAllSupportedMcs(), AddAllSupportedModes(), AddSupportedErpSlotTime(), AddSupportedMcs(), AddSupportedMode(), AddSupportedPhyPreamble(), GetAssociationId(), GetInfo(), GetQosSupported(), GetShortPreambleSupported(), GetShortSlotTimeSupported(), IsAssociated(), IsAssocRefused(), IsBrandNew(), IsInPsMode(), IsWaitAssocTxOk(), RecordAssocRefused(), RecordDisassociated(), RecordGotAssocTxFailed(), RecordGotAssocTxOk(), RecordWaitAssocTxOk(), RemoveAllSupportedMcs(), and SetPsMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NeedCtsToSelf()

bool ns3::WifiRemoteStationManager::NeedCtsToSelf ( WifiTxVector txVector )

Return if we need to do CTS-to-self before sending a DATA.

Parameters

txVector the TXVECTOR of the packet to be sent

Returns: true if CTS-to-self is needed, false otherwise

Definition at line 1141 of file wifi-remote-station-manager.cc.

References CTS_TO_SELF, ns3::WifiPhy::GetDevice(), ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetModulationClass(), m_bssBasicMcsSet, m_bssBasicRateSet, m_erpProtectionMode, m_htProtectionMode, m_useNonErpProtection, m_useNonHtProtection, m_wifiPhy, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_EHT, ns3::WIFI_MOD_CLASS_ERP_OFDM, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Here is the call graph for this function:

◆ NeedFragmentation()

bool ns3::WifiRemoteStationManager::NeedFragmentation ( Ptr< const WifiMpdu > mpdu )

Parameters

mpdu	the MPDU to send

Returns: true if this packet should be fragmented, false otherwise.

Definition at line 1250 of file wifi-remote-station-manager.cc.

References DoNeedFragmentation(), GetFragmentationThreshold(), Lookup(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NeedRetransmission()

bool ns3::WifiRemoteStationManager::NeedRetransmission ( Ptr< const WifiMpdu > mpdu )

Parameters

mpdu	the MPDU to send

Returns: true if we want to resend a packet after a failed transmission attempt, false otherwise.

Definition at line 1224 of file wifi-remote-station-manager.cc.

References DoNeedRetransmission(), Lookup(), m_maxSlrc, m_maxSsrc, m_rtsCtsThreshold, m_slrc, m_ssrc, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ NeedRts()

bool ns3::WifiRemoteStationManager::NeedRts	(	const WifiMacHeader &	header,
		const WifiTxParameters &	txParams )

Parameters

header	MAC header of the data frame to send
txParams	the TX parameters for the data frame to send

Returns: true if we want to use an RTS/CTS handshake for this frame before sending it, false otherwise.

Definition at line 1106 of file wifi-remote-station-manager.cc.

References DoNeedRts(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiTxVector::GetModulationClass(), ns3::WifiTxParameters::GetSize(), ns3::Time::IsStrictlyPositive(), Lookup(), m_erpProtectionMode, m_htProtectionMode, m_rtsCtsThreshold, m_rtsCtsTxDurationThresh, ns3::WifiTxParameters::m_txDuration, ns3::WifiTxParameters::m_txVector, m_useNonErpProtection, m_useNonHtProtection, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, RTS_CTS, ns3::WIFI_MOD_CLASS_EHT, ns3::WIFI_MOD_CLASS_ERP_OFDM, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Here is the call graph for this function:

◆ RecordAssocRefused()

void ns3::WifiRemoteStationManager::RecordAssocRefused ( Mac48Address address )

Records that association request was refused.

Parameters

address the address of the station

Definition at line 495 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::ASSOC_REFUSED, LookupState(), and NS_ASSERT.

Here is the call graph for this function:

◆ RecordDisassociated()

void ns3::WifiRemoteStationManager::RecordDisassociated ( Mac48Address address )

Records that the STA was disassociated.

Parameters

address the address of the station

Definition at line 478 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::DISASSOC, LookupState(), and NS_ASSERT.

Here is the call graph for this function:

◆ RecordGotAssocTxFailed()

void ns3::WifiRemoteStationManager::RecordGotAssocTxFailed ( Mac48Address address )

Records that we missed an ACK for the association response we sent.

Parameters

address the address of the station

Definition at line 471 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::DISASSOC, LookupState(), and NS_ASSERT.

Here is the call graph for this function:

◆ RecordGotAssocTxOk()

void ns3::WifiRemoteStationManager::RecordGotAssocTxOk ( Mac48Address address )

Records that we got an ACK for the association response we sent.

Parameters

address the address of the station

Definition at line 464 of file wifi-remote-station-manager.cc.

References ns3::WifiRemoteStationState::GOT_ASSOC_TX_OK, LookupState(), and NS_ASSERT.

Here is the call graph for this function:

◆ RecordWaitAssocTxOk()

void ns3::WifiRemoteStationManager::RecordWaitAssocTxOk ( Mac48Address address )

Records that we are waiting for an ACK for the association response we sent.

Parameters

address the address of the station

Definition at line 457 of file wifi-remote-station-manager.cc.

References LookupState(), NS_ASSERT, and ns3::WifiRemoteStationState::WAIT_ASSOC_TX_OK.

Here is the call graph for this function:

◆ RemoveAllSupportedMcs()

void ns3::WifiRemoteStationManager::RemoveAllSupportedMcs ( Mac48Address address )

Invoked in a STA or AP to delete all of the supported MCS by a destination.

Parameters

address the address of the station being recorded

Definition at line 385 of file wifi-remote-station-manager.cc.

References LookupState(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ReportAmpduTxStatus()

void ns3::WifiRemoteStationManager::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.

Parameters

address	the address of the receiver
nSuccessfulMpdus	number of successfully transmitted MPDUs A value of 0 means that the Block ACK was missed.
nFailedMpdus	number of unsuccessfuly transmitted MPDUs
rxSnr	received SNR of the block ack frame itself
dataSnr	data SNR reported by remote station
dataTxVector	the TXVECTOR of the MPDUs we sent

Definition at line 1082 of file wifi-remote-station-manager.cc.

References DoReportAmpduTxStatus(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetNss(), GetStaId(), Lookup(), m_macTxDataFailed, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ReportDataFailed()

void ns3::WifiRemoteStationManager::ReportDataFailed ( Ptr< const WifiMpdu > mpdu )

Should be invoked whenever the AckTimeout associated to a transmission attempt expires.

Parameters

mpdu	the MPDU whose transmission failed

Definition at line 966 of file wifi-remote-station-manager.cc.

References DoReportDataFailed(), Lookup(), m_macTxDataFailed, m_rtsCtsThreshold, m_slrc, m_ssrc, NS_ASSERT, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ ReportDataOk()

void ns3::WifiRemoteStationManager::ReportDataOk	(	Ptr< const WifiMpdu >	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.

Parameters

mpdu	the MPDU
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
dataTxVector	the TXVECTOR of the DATA we sent

Definition at line 1001 of file wifi-remote-station-manager.cc.

References DoReportDataOk(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetNss(), ns3::WifiMacHeader::GetQosTid(), GetStaId(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsQosData(), Lookup(), ns3::WifiRemoteStationState::m_info, m_rtsCtsThreshold, m_slrc, m_ssrc, ns3::WifiRemoteStation::m_state, ns3::WifiRemoteStationInfo::NotifyTxSuccess(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ ReportFinalDataFailed()

void ns3::WifiRemoteStationManager::ReportFinalDataFailed ( Ptr< const WifiMpdu > mpdu )

Should be invoked after calling ReportDataFailed if NeedRetransmission returns false.

Parameters

mpdu	the MPDU which was discarded

Definition at line 1045 of file wifi-remote-station-manager.cc.

References DoReportFinalDataFailed(), Lookup(), ns3::WifiRemoteStationState::m_info, m_macTxFinalDataFailed, m_rtsCtsThreshold, m_slrc, m_ssrc, ns3::WifiRemoteStation::m_state, ns3::WifiRemoteStationInfo::NotifyTxFailed(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ ReportFinalRtsFailed()

void ns3::WifiRemoteStationManager::ReportFinalRtsFailed ( const WifiMacHeader & header )

Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false.

Parameters

header MAC header of the DATA packet

Definition at line 1032 of file wifi-remote-station-manager.cc.

References DoReportFinalRtsFailed(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetQosTid(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsQosData(), Lookup(), ns3::WifiRemoteStationState::m_info, m_macTxFinalRtsFailed, m_ssrc, ns3::WifiRemoteStation::m_state, ns3::WifiRemoteStationInfo::NotifyTxFailed(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ ReportRtsFailed()

void ns3::WifiRemoteStationManager::ReportRtsFailed ( const WifiMacHeader & header )

Should be invoked whenever the RtsTimeout associated to a transmission attempt expires.

Parameters

header MAC header of the DATA packet

Definition at line 955 of file wifi-remote-station-manager.cc.

References DoReportRtsFailed(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetQosTid(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsQosData(), Lookup(), m_macTxRtsFailed, m_ssrc, NS_ASSERT, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ ReportRtsOk()

void ns3::WifiRemoteStationManager::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.

Note that we also get the SNR of the RTS we sent since the receiver put a SnrTag in the CTS.

Parameters

header	MAC header of the DATA packet
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

Definition at line 986 of file wifi-remote-station-manager.cc.

References DoReportRtsOk(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetQosTid(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsQosData(), Lookup(), ns3::WifiRemoteStationState::m_info, m_ssrc, ns3::WifiRemoteStation::m_state, ns3::WifiRemoteStationInfo::NotifyTxSuccess(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::QosUtilsMapTidToAc().

Here is the call graph for this function:

◆ ReportRxOk()

void ns3::WifiRemoteStationManager::ReportRxOk	(	Mac48Address	address,
		RxSignalInfo	rxSignalInfo,
		WifiTxVector	txVector )

Parameters

address	remote address
rxSignalInfo	the info on the received signal (

See also: RxSignalInfo)

Parameters

txVector the TXVECTOR used for the packet received

Should be invoked whenever a packet is successfully received.

Definition at line 1067 of file wifi-remote-station-manager.cc.

References DoReportRxOk(), ns3::WifiTxVector::GetMode(), GetStaId(), Lookup(), ns3::WifiRemoteStation::m_rssiAndUpdateTimePair, ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::RxSignalInfo::rssi, and ns3::RxSignalInfo::snr.

Here is the call graph for this function:

◆ Reset()

void ns3::WifiRemoteStationManager::Reset ( )

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

Definition at line 1742 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::IdealWifiManager::DoCreateStation(), DoDispose(), ns3::IdealWifiManager::DoReportFinalDataFailed(), and ns3::IdealWifiManager::DoReportFinalRtsFailed().

Here is the caller graph for this function:

◆ SetAssociationId()

void ns3::WifiRemoteStationManager::SetAssociationId	(	Mac48Address	remoteAddress,
		uint16_t	aid )

Record the AID of a remote station.

Should only be called by APs.

Parameters

remoteAddress	the MAC address of the remote station
aid	the Association ID

Definition at line 1456 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

◆ SetDefaultTxPowerLevel()

void ns3::WifiRemoteStationManager::SetDefaultTxPowerLevel ( uint8_t txPower )

Set the default transmission power level.

Parameters

txPower the default transmission power level

Definition at line 2193 of file wifi-remote-station-manager.cc.

◆ SetEmlsrEnabled()

void ns3::WifiRemoteStationManager::SetEmlsrEnabled	(	const Mac48Address &	from,
		bool	emlsrEnabled )

Parameters

from	the address of the station being recorded
emlsrEnabled	whether EMLSR mode is enabled for the station on this link

Definition at line 1470 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

◆ SetFragmentationThreshold()

void ns3::WifiRemoteStationManager::SetFragmentationThreshold ( uint32_t threshold )

Sets a fragmentation threshold.

The method calls a private method DoSetFragmentationThreshold that checks the validity of the value given.

Parameters

threshold the fragmentation threshold

Definition at line 210 of file wifi-remote-station-manager.cc.

References DoSetFragmentationThreshold(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetMaxSlrc()

void ns3::WifiRemoteStationManager::SetMaxSlrc ( uint32_t maxSlrc )

Sets the maximum STA long retry count (SLRC).

Parameters

maxSlrc the maximum SLRC

Definition at line 196 of file wifi-remote-station-manager.cc.

References m_maxSlrc, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetMaxSsrc()

void ns3::WifiRemoteStationManager::SetMaxSsrc ( uint32_t maxSsrc )

Sets the maximum STA short retry count (SSRC).

Parameters

maxSsrc the maximum SSRC

Definition at line 189 of file wifi-remote-station-manager.cc.

References m_maxSsrc, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPsMode()

void ns3::WifiRemoteStationManager::SetPsMode	(	const Mac48Address &	address,
		bool	isInPsMode )

Register whether the STA is in Power Save mode or not.

Parameters

address	the address of the station
isInPsMode	whether the STA is in PS mode or not

Definition at line 547 of file wifi-remote-station-manager.cc.

References LookupState().

Here is the call graph for this function:

◆ SetQosSupport()

void ns3::WifiRemoteStationManager::SetQosSupport	(	Mac48Address	from,
		bool	qosSupported )

Records QoS support of the remote station.

Parameters

from	the address of the station being recorded
qosSupported	whether the station supports QoS

Definition at line 1463 of file wifi-remote-station-manager.cc.

References NS_LOG_FUNCTION.

◆ SetRtsCtsThreshold()

void ns3::WifiRemoteStationManager::SetRtsCtsThreshold ( uint32_t threshold )

Sets the RTS threshold.

Parameters

threshold the RTS threshold

Definition at line 203 of file wifi-remote-station-manager.cc.

References m_rtsCtsThreshold, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetShortPreambleEnabled()

void ns3::WifiRemoteStationManager::SetShortPreambleEnabled ( bool enable )

Enable or disable short PHY preambles.

Parameters

enable enable or disable short PHY preambles

Definition at line 217 of file wifi-remote-station-manager.cc.

References m_shortPreambleEnabled, and NS_LOG_FUNCTION.

◆ SetShortSlotTimeEnabled()

void ns3::WifiRemoteStationManager::SetShortSlotTimeEnabled ( bool enable )

Enable or disable short slot time.

Parameters

enable enable or disable short slot time

Definition at line 224 of file wifi-remote-station-manager.cc.

References m_shortSlotTimeEnabled, and NS_LOG_FUNCTION.

◆ SetupMac()

void ns3::WifiRemoteStationManager::SetupMac ( const Ptr< WifiMac > mac )

virtual

Set up MAC associated with this device since it is the object that knows the full set of timing parameters (e.g.

IFS).

Parameters

mac	the MAC of this device

Reimplemented in ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::RraaWifiManager, and ns3::RrpaaWifiManager.

Definition at line 173 of file wifi-remote-station-manager.cc.

References m_wifiMac, and NS_LOG_FUNCTION.

Referenced by ns3::MinstrelHtWifiManager::SetupMac(), ns3::MinstrelWifiManager::SetupMac(), ns3::RraaWifiManager::SetupMac(), and ns3::RrpaaWifiManager::SetupMac().

Here is the caller graph for this function:

◆ SetupPhy()

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

virtual

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

Parameters

phy	the PHY of this device

Reimplemented in ns3::AparfWifiManager, ns3::IdealWifiManager, ns3::MinstrelHtWifiManager, ns3::MinstrelWifiManager, ns3::ParfWifiManager, ns3::RraaWifiManager, and ns3::RrpaaWifiManager.

Definition at line 161 of file wifi-remote-station-manager.cc.

References m_wifiPhy, and NS_LOG_FUNCTION.

Referenced by ns3::AparfWifiManager::SetupPhy(), ns3::IdealWifiManager::SetupPhy(), ns3::MinstrelHtWifiManager::SetupPhy(), ns3::MinstrelWifiManager::SetupPhy(), ns3::ParfWifiManager::SetupPhy(), ns3::RraaWifiManager::SetupPhy(), and ns3::RrpaaWifiManager::SetupPhy().

Here is the caller graph for this function:

◆ SetUseNonErpProtection()

void ns3::WifiRemoteStationManager::SetUseNonErpProtection ( bool enable )

Enable or disable protection for non-ERP stations.

Parameters

enable enable or disable protection for non-ERP stations

Definition at line 1198 of file wifi-remote-station-manager.cc.

References m_useNonErpProtection, and NS_LOG_FUNCTION.

◆ SetUseNonHtProtection()

void ns3::WifiRemoteStationManager::SetUseNonHtProtection ( bool enable )

Enable or disable protection for non-HT stations.

Parameters

enable enable or disable protection for non-HT stations

Definition at line 1211 of file wifi-remote-station-manager.cc.

References m_useNonHtProtection, and NS_LOG_FUNCTION.

◆ UseLdpcForDestination()

bool ns3::WifiRemoteStationManager::UseLdpcForDestination ( Mac48Address dest ) const

Returns: whether LDPC should be used for a given destination address.

Parameters

dest	the destination address

Returns: whether LDPC should be used for a given destination address

Definition at line 2211 of file wifi-remote-station-manager.cc.

Referenced by GetDataTxVector().

Here is the caller graph for this function:

Member Data Documentation

◆ m_bssBasicMcsSet

WifiModeList ns3::WifiRemoteStationManager::m_bssBasicMcsSet

private

basic MCS set

Definition at line 1500 of file wifi-remote-station-manager.h.

Referenced by NeedCtsToSelf().

◆ m_bssBasicRateSet

WifiModeList ns3::WifiRemoteStationManager::m_bssBasicRateSet

private

This member is the list of WifiMode objects that comprise the BSSBasicRateSet parameter.

This list is constructed through calls to WifiRemoteStationManager::AddBasicMode(), and an API that allows external access to it is available through WifiRemoteStationManager::GetNBasicModes() and WifiRemoteStationManager::GetBasicMode(). basic rate set

Definition at line 1499 of file wifi-remote-station-manager.h.

Referenced by NeedCtsToSelf().

◆ m_defaultTxPowerLevel

uint8_t ns3::WifiRemoteStationManager::m_defaultTxPowerLevel

private

Default transmission power level.

Definition at line 1510 of file wifi-remote-station-manager.h.

Referenced by GetDataTxVector(), GetDefaultTxPowerLevel(), GetRtsTxVector(), and GetTypeId().

◆ m_erpProtectionMode

ProtectionMode ns3::WifiRemoteStationManager::m_erpProtectionMode

private

Protection mode for ERP stations when non-ERP stations are detected.

Definition at line 1518 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), NeedCtsToSelf(), and NeedRts().

◆ m_fragmentationThreshold

uint32_t ns3::WifiRemoteStationManager::m_fragmentationThreshold

private

Current threshold for fragmentation.

Definition at line 1509 of file wifi-remote-station-manager.h.

Referenced by DoGetFragmentationThreshold(), and DoSetFragmentationThreshold().

◆ m_htProtectionMode

ProtectionMode ns3::WifiRemoteStationManager::m_htProtectionMode

private

Protection mode for HT stations when non-HT stations are detected.

Definition at line 1521 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), NeedCtsToSelf(), and NeedRts().

◆ m_macTxDataFailed

TracedCallback<Mac48Address> ns3::WifiRemoteStationManager::m_macTxDataFailed

private

The trace source fired when the transmission of a single data packet has failed.

Definition at line 1533 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), ReportAmpduTxStatus(), and ReportDataFailed().

◆ m_macTxFinalDataFailed

TracedCallback<Mac48Address> ns3::WifiRemoteStationManager::m_macTxFinalDataFailed

private

The trace source fired when the transmission of a data packet has exceeded the maximum number of attempts.

Definition at line 1543 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), and ReportFinalDataFailed().

◆ m_macTxFinalRtsFailed

TracedCallback<Mac48Address> ns3::WifiRemoteStationManager::m_macTxFinalRtsFailed

private

The trace source fired when the transmission of a RTS has exceeded the maximum number of attempts.

Definition at line 1538 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), and ReportFinalRtsFailed().

◆ m_macTxRtsFailed

TracedCallback<Mac48Address> ns3::WifiRemoteStationManager::m_macTxRtsFailed

private

The trace source fired when the transmission of a single RTS has failed.

Definition at line 1529 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), and ReportRtsFailed().

◆ m_maxSlrc

uint32_t ns3::WifiRemoteStationManager::m_maxSlrc

private

Maximum STA long retry count (SLRC)

Definition at line 1506 of file wifi-remote-station-manager.h.

Referenced by NeedRetransmission(), and SetMaxSlrc().

◆ m_maxSsrc

uint32_t ns3::WifiRemoteStationManager::m_maxSsrc

private

Maximum STA short retry count (SSRC)

Definition at line 1505 of file wifi-remote-station-manager.h.

Referenced by NeedRetransmission(), and SetMaxSsrc().

◆ m_nonUnicastMode

WifiMode ns3::WifiRemoteStationManager::m_nonUnicastMode

private

Transmission mode for non-unicast Data frames.

Definition at line 1511 of file wifi-remote-station-manager.h.

Referenced by GetTypeId().

◆ m_rtsCtsThreshold

uint32_t ns3::WifiRemoteStationManager::m_rtsCtsThreshold

private

Threshold for RTS/CTS.

Definition at line 1507 of file wifi-remote-station-manager.h.

Referenced by NeedRetransmission(), NeedRts(), ReportDataFailed(), ReportDataOk(), ReportFinalDataFailed(), and SetRtsCtsThreshold().

◆ m_rtsCtsTxDurationThresh

Time ns3::WifiRemoteStationManager::m_rtsCtsTxDurationThresh

private

TX duration threshold for RTS/CTS.

Definition at line 1508 of file wifi-remote-station-manager.h.

Referenced by GetTypeId(), and NeedRts().

◆ m_shortPreambleEnabled

bool ns3::WifiRemoteStationManager::m_shortPreambleEnabled

private

flag if short PHY preamble is enabled

Definition at line 1516 of file wifi-remote-station-manager.h.

Referenced by GetShortPreambleEnabled(), and SetShortPreambleEnabled().

◆ m_shortSlotTimeEnabled

bool ns3::WifiRemoteStationManager::m_shortSlotTimeEnabled

private

flag if short slot time is enabled

Definition at line 1517 of file wifi-remote-station-manager.h.

Referenced by GetShortSlotTimeEnabled(), and SetShortSlotTimeEnabled().

◆ m_slrc

std::array<uint32_t, AC_BE_NQOS> ns3::WifiRemoteStationManager::m_slrc

private

long retry count per AC

Definition at line 1524 of file wifi-remote-station-manager.h.

Referenced by WifiRemoteStationManager(), NeedRetransmission(), ReportDataFailed(), ReportDataOk(), and ReportFinalDataFailed().

◆ m_ssrc

std::array<uint32_t, AC_BE_NQOS> ns3::WifiRemoteStationManager::m_ssrc

private

short retry count per AC

Definition at line 1523 of file wifi-remote-station-manager.h.

Referenced by WifiRemoteStationManager(), NeedRetransmission(), ReportDataFailed(), ReportDataOk(), ReportFinalDataFailed(), ReportFinalRtsFailed(), ReportRtsFailed(), and ReportRtsOk().

◆ m_states

StationStates ns3::WifiRemoteStationManager::m_states

private

States of known stations.

Definition at line 1502 of file wifi-remote-station-manager.h.

Referenced by GetAffiliatedStaAddress(), GetMldAddress(), and LookupState().

◆ m_stations

Stations ns3::WifiRemoteStationManager::m_stations

private

Information for each known stations.

Definition at line 1503 of file wifi-remote-station-manager.h.

◆ m_useNonErpProtection

bool ns3::WifiRemoteStationManager::m_useNonErpProtection

private

flag if protection for non-ERP stations against ERP transmissions is enabled

Definition at line 1512 of file wifi-remote-station-manager.h.

Referenced by GetUseNonErpProtection(), NeedCtsToSelf(), NeedRts(), and SetUseNonErpProtection().

◆ m_useNonHtProtection

bool ns3::WifiRemoteStationManager::m_useNonHtProtection

private

flag if protection for non-HT stations against HT transmissions is enabled

Definition at line 1514 of file wifi-remote-station-manager.h.

Referenced by GetUseNonHtProtection(), NeedCtsToSelf(), NeedRts(), and SetUseNonHtProtection().

◆ m_wifiMac

Ptr<WifiMac> ns3::WifiRemoteStationManager::m_wifiMac

private

This is a pointer to the WifiMac associated with this WifiRemoteStationManager that is set on call to WifiRemoteStationManager::SetupMac().

Through this pointer the station manager can determine MAC characteristics, such as the interframe spaces.

Definition at line 1489 of file wifi-remote-station-manager.h.

Referenced by GetStaId(), and SetupMac().

◆ m_wifiPhy

Ptr<WifiPhy> ns3::WifiRemoteStationManager::m_wifiPhy

private

This is a pointer to the WifiPhy associated with this WifiRemoteStationManager that is set on call to WifiRemoteStationManager::SetupPhy().

Through this pointer the station manager can determine PHY characteristics, such as the set of all transmission rates that may be supported (the "DeviceRateSet").

Definition at line 1481 of file wifi-remote-station-manager.h.

Referenced by AddAllSupportedMcs(), AddAllSupportedModes(), AdjustTxVectorForIcf(), GetAckTxVector(), GetBlockAckTxVector(), GetControlAnswerMode(), GetCtsToSelfTxVector(), GetCtsTxVector(), GetDataTxVector(), GetEhtSupported(), GetGuardInterval(), GetHeSupported(), GetHtSupported(), GetLdpcSupported(), GetRtsTxVector(), GetShortGuardIntervalSupported(), GetVhtSupported(), LookupState(), NeedCtsToSelf(), and SetupPhy().

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

src/wifi/model/wifi-remote-station-manager.h
src/wifi/model/wifi-remote-station-manager.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PowerChangeTracedCallback

◆ RateChangeTracedCallback

◆ Stations

◆ StationStates

Member Enumeration Documentation

◆ ProtectionMode

Constructor & Destructor Documentation

◆ WifiRemoteStationManager()

◆ ~WifiRemoteStationManager()

Member Function Documentation

◆ AddAllSupportedMcs()

◆ AddAllSupportedModes()

◆ AddBasicMcs()

◆ AddBasicMode()

◆ AddStationEhtCapabilities()

◆ AddStationHe6GhzCapabilities()

◆ AddStationHeCapabilities()

◆ AddStationHtCapabilities()

◆ AddStationMleCommonInfo()

◆ AddStationVhtCapabilities()

◆ AddSupportedErpSlotTime()

◆ AddSupportedMcs()

◆ AddSupportedMode()

◆ AddSupportedPhyPreamble()

◆ AdjustTxVectorForIcf()

◆ AssignStreams()

◆ DoCreateStation()

◆ DoDispose()

◆ DoGetDataTxVector()

◆ DoGetFragmentationThreshold()

◆ DoGetRtsTxVector()

◆ DoNeedFragmentation()

◆ DoNeedRetransmission()

◆ DoNeedRts()

◆ DoReportAmpduTxStatus()

◆ DoReportDataFailed()

◆ DoReportDataOk()

◆ DoReportFinalDataFailed()

◆ DoReportFinalRtsFailed()

◆ DoReportRtsFailed()

◆ DoReportRtsOk()

◆ DoReportRxOk()

◆ DoSetFragmentationThreshold()

◆ GetAckTxVector()

◆ GetAddress()

◆ GetAffiliatedStaAddress()

◆ GetAggregation()

◆ GetAssociationId()

◆ GetBasicMcs()

◆ GetBasicMode()

◆ GetBlockAckTxVector()

◆ GetChannelWidth()

◆ GetChannelWidthSupported()

◆ GetControlAnswerMode()

◆ GetCtsToSelfTxVector()

◆ GetCtsTxVector()

◆ GetDataTxVector()

◆ GetDefaultMcs()

◆ GetDefaultMode()

◆ GetDefaultModeForSta()

◆ GetDefaultTxPowerLevel()

◆ GetDsssSupported()

◆ GetEhtSupported() [1/3]

◆ GetEhtSupported() [2/3]

◆ GetEhtSupported() [3/3]

◆ GetEmlsrEnabled() [1/2]

◆ GetEmlsrEnabled() [2/2]

◆ GetEmlsrSupported() [1/2]

◆ GetEmlsrSupported() [2/2]

◆ GetErpOfdmSupported()

◆ GetFragmentationThreshold()