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

#include "rrpaa-wifi-manager.h"

+ Inheritance diagram for ns3::RrpaaWifiManager:
+ Collaboration diagram for ns3::RrpaaWifiManager:

Public Member Functions

 RrpaaWifiManager ()
 
 ~RrpaaWifiManager () override
 
int64_t AssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
void SetupMac (const Ptr< WifiMac > mac) override
 Set up MAC associated with this device since it is the object that knows the full set of timing parameters (e.g. More...
 
void SetupPhy (const Ptr< WifiPhy > phy) override
 Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported. More...
 
- Public Member Functions inherited from ns3::WifiRemoteStationManager
 WifiRemoteStationManager ()
 
 ~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. More...
 
void AddAllSupportedModes (Mac48Address address)
 Invoked in a STA or AP to store all of the modes supported by a destination which is also supported locally. More...
 
void AddBasicMcs (WifiMode mcs)
 Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS. More...
 
void AddBasicMode (WifiMode mode)
 Invoked in a STA upon association to store the set of rates which belong to the BSSBasicRateSet of the associated AP and which are supported locally. More...
 
void AddStationEhtCapabilities (Mac48Address from, EhtCapabilities ehtCapabilities)
 Records EHT capabilities of the remote station. More...
 
void AddStationHeCapabilities (Mac48Address from, HeCapabilities heCapabilities)
 Records HE capabilities of the remote station. More...
 
void AddStationHtCapabilities (Mac48Address from, HtCapabilities htCapabilities)
 Records HT capabilities of the remote station. More...
 
void 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. More...
 
void AddStationVhtCapabilities (Mac48Address from, VhtCapabilities vhtCapabilities)
 Records VHT capabilities of the remote station. More...
 
void AddSupportedErpSlotTime (Mac48Address address, bool isShortSlotTimeSupported)
 Record whether the short ERP slot time is supported by the station. More...
 
void AddSupportedMcs (Mac48Address address, WifiMode mcs)
 Record the MCS index supported by the station. More...
 
void AddSupportedMode (Mac48Address address, WifiMode mode)
 Invoked in a STA or AP to store the set of modes supported by a destination which is also supported locally. More...
 
void AddSupportedPhyPreamble (Mac48Address address, bool isShortPreambleSupported)
 Record whether the short PHY preamble is supported by the station. More...
 
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. More...
 
WifiTxVector GetAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
 Return a TXVECTOR for the Ack frame given the destination and the mode of the Data used by the sender. More...
 
std::optional< Mac48AddressGetAffiliatedStaAddress (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. More...
 
uint16_t GetAssociationId (Mac48Address remoteAddress) const
 Get the AID of a remote station. More...
 
WifiMode GetBasicMcs (uint8_t i) const
 Return the MCS at the given list index. More...
 
WifiMode GetBasicMode (uint8_t i) const
 Return a basic mode from the set of basic modes. More...
 
WifiTxVector GetBlockAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
 Return a TXVECTOR for the BlockAck frame given the destination and the mode of the Data used by the sender. More...
 
uint16_t GetChannelWidthSupported (Mac48Address address) const
 Return the channel width supported by the station. More...
 
WifiMode GetControlAnswerMode (WifiMode reqMode) const
 Get control answer mode function. More...
 
WifiTxVector GetCtsToSelfTxVector ()
 Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote station manager. More...
 
WifiTxVector GetCtsTxVector (Mac48Address to, WifiMode rtsTxMode) const
 Return a TXVECTOR for the CTS frame given the destination and the mode of the RTS used by the sender. More...
 
WifiTxVector GetDataTxVector (const WifiMacHeader &header, uint16_t allowedWidth)
 
WifiMode GetDefaultMcs () const
 Return the default Modulation and Coding Scheme (MCS) index. More...
 
WifiMode GetDefaultMode () const
 Return the default transmission mode. More...
 
WifiMode GetDefaultModeForSta (const WifiRemoteStation *st) const
 Return the default MCS to use to transmit frames to the given station. More...
 
uint8_t GetDefaultTxPowerLevel () const
 
bool GetDsssSupported (const Mac48Address &address) const
 Return whether the station supports DSSS or not. More...
 
bool GetEhtSupported () const
 Return whether the device has EHT capability support enabled. More...
 
bool GetEhtSupported (Mac48Address address) const
 Return whether the station supports EHT or not. More...
 
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. More...
 
uint32_t GetFragmentationThreshold () const
 Return the fragmentation threshold. More...
 
uint32_t GetFragmentOffset (Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
 
uint32_t GetFragmentSize (Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
 
uint16_t GetGuardInterval () const
 Return the supported HE guard interval duration (in nanoseconds). More...
 
bool GetHeSupported () const
 Return whether the device has HE capability support enabled. More...
 
bool GetHeSupported (Mac48Address address) const
 Return whether the station supports HE or not. More...
 
bool GetHtSupported () const
 Return whether the device has HT capability support enabled. More...
 
bool GetHtSupported (Mac48Address address) const
 Return whether the station supports HT or not. More...
 
WifiRemoteStationInfo GetInfo (Mac48Address address)
 
bool GetLdpcSupported () const
 Return whether the device has LDPC support enabled. More...
 
bool GetLdpcSupported (Mac48Address address) const
 Return whether the station supports LDPC or not. More...
 
Ptr< WifiMacGetMac () const
 Return the WifiMac. More...
 
uint8_t GetMaxNumberOfTransmitStreams () const
 
std::optional< Mac48AddressGetMldAddress (const Mac48Address &address) const
 Get the address of the MLD the given station is affiliated with, if any. More...
 
std::optional< double > GetMostRecentRssi (Mac48Address address) const
 
uint8_t GetNBasicMcs () const
 Return the number of basic MCS index. More...
 
uint8_t GetNBasicModes () const
 Return the number of basic modes we support. More...
 
uint8_t GetNMcsSupported (Mac48Address address) const
 Return the number of MCS supported by the station. More...
 
uint32_t GetNNonErpBasicModes () const
 Return the number of non-ERP basic modes we support. More...
 
WifiMode GetNonErpBasicMode (uint8_t i) const
 Return a basic mode from the set of basic modes that is not an ERP mode. More...
 
WifiMode GetNonUnicastMode () const
 Return a mode for non-unicast packets. More...
 
uint8_t GetNumberOfAntennas () const
 
uint8_t GetNumberOfSupportedStreams (Mac48Address address) const
 Return the number of spatial streams supported by the station. More...
 
bool GetOfdmSupported (const Mac48Address &address) const
 Return whether the station supports OFDM or not. More...
 
Ptr< WifiPhyGetPhy () const
 Return the WifiPhy. More...
 
bool GetQosSupported (Mac48Address address) const
 Return whether the given station is QoS capable. More...
 
WifiTxVector GetRtsTxVector (Mac48Address address, uint16_t allowedWidth)
 
bool GetShortGuardIntervalSupported () const
 Return whether the device has SGI support enabled. More...
 
bool GetShortGuardIntervalSupported (Mac48Address address) const
 Return whether the station supports HT/VHT short guard interval. More...
 
bool GetShortPreambleEnabled () const
 Return whether the device uses short PHY preambles. More...
 
bool GetShortPreambleSupported (Mac48Address address) const
 Return whether the station supports short PHY preamble or not. More...
 
bool GetShortSlotTimeEnabled () const
 Return whether the device uses short slot time. More...
 
bool GetShortSlotTimeSupported (Mac48Address address) const
 Return whether the station supports short ERP slot time or not. More...
 
Ptr< const EhtCapabilitiesGetStationEhtCapabilities (Mac48Address from)
 Return the EHT capabilities sent by the remote station. More...
 
std::optional< std::reference_wrapper< CommonInfoBasicMle::EmlCapabilities > > GetStationEmlCapabilities (const Mac48Address &from)
 
Ptr< const HeCapabilitiesGetStationHeCapabilities (Mac48Address from)
 Return the HE capabilities sent by the remote station. More...
 
Ptr< const HtCapabilitiesGetStationHtCapabilities (Mac48Address from)
 Return the HT capabilities sent by the remote station. More...
 
std::optional< std::reference_wrapper< CommonInfoBasicMle::MldCapabilities > > GetStationMldCapabilities (const Mac48Address &from)
 
Ptr< const VhtCapabilitiesGetStationVhtCapabilities (Mac48Address from)
 Return the VHT capabilities sent by the remote station. More...
 
bool GetUseNonErpProtection () const
 Return whether the device supports protection of non-ERP stations. More...
 
bool GetUseNonHtProtection () const
 Return whether the device supports protection of non-HT stations. More...
 
bool GetVhtSupported () const
 Return whether the device has VHT capability support enabled. More...
 
bool GetVhtSupported (Mac48Address address) const
 Return whether the station supports VHT or not. More...
 
bool IsAssociated (Mac48Address address) const
 Return whether the station associated. More...
 
bool IsAssocRefused (Mac48Address address) const
 Return whether we refused an association request from the given station. More...
 
bool IsBrandNew (Mac48Address address) const
 Return whether the station state is brand new. More...
 
bool IsInPsMode (const Mac48Address &address) const
 Return whether the STA is currently in Power Save mode. More...
 
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. More...
 
bool NeedCtsToSelf (WifiTxVector txVector)
 Return if we need to do CTS-to-self before sending a DATA. More...
 
bool NeedFragmentation (Ptr< const WifiMpdu > mpdu)
 
bool NeedRetransmission (Ptr< const WifiMpdu > mpdu)
 
bool NeedRts (const WifiMacHeader &header, uint32_t size)
 
void RecordAssocRefused (Mac48Address address)
 Records that association request was refused. More...
 
void RecordDisassociated (Mac48Address address)
 Records that the STA was disassociated. More...
 
void RecordGotAssocTxFailed (Mac48Address address)
 Records that we missed an ACK for the association response we sent. More...
 
void RecordGotAssocTxOk (Mac48Address address)
 Records that we got an ACK for the association response we sent. More...
 
void RecordWaitAssocTxOk (Mac48Address address)
 Records that we are waiting for an ACK for the association response we sent. More...
 
void RemoveAllSupportedMcs (Mac48Address address)
 Invoked in a STA or AP to delete all of the supported MCS by a destination. More...
 
void ReportAmpduTxStatus (Mac48Address address, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, WifiTxVector dataTxVector)
 Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...
 
void ReportDataFailed (Ptr< const WifiMpdu > mpdu)
 Should be invoked whenever the AckTimeout associated to a transmission attempt expires. More...
 
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. More...
 
void ReportFinalDataFailed (Ptr< const WifiMpdu > mpdu)
 Should be invoked after calling ReportDataFailed if NeedRetransmission returns false. More...
 
void ReportFinalRtsFailed (const WifiMacHeader &header)
 Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false. More...
 
void ReportRtsFailed (const WifiMacHeader &header)
 Should be invoked whenever the RtsTimeout associated to a transmission attempt expires. More...
 
void ReportRtsOk (const WifiMacHeader &header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
 Should be invoked whenever we receive the CTS associated to an RTS we just sent. More...
 
void ReportRxOk (Mac48Address address, RxSignalInfo rxSignalInfo, WifiTxVector txVector)
 
void Reset ()
 Reset the station, invoked in a STA upon dis-association or in an AP upon reboot. More...
 
void SetAssociationId (Mac48Address remoteAddress, uint16_t aid)
 Record the AID of a remote station. More...
 
void SetDefaultTxPowerLevel (uint8_t txPower)
 Set the default transmission power level. More...
 
void SetEmlsrEnabled (const Mac48Address &from, bool emlsrEnabled)
 
void SetFragmentationThreshold (uint32_t threshold)
 Sets a fragmentation threshold. More...
 
void SetMaxSlrc (uint32_t maxSlrc)
 Sets the maximum STA long retry count (SLRC). More...
 
void SetMaxSsrc (uint32_t maxSsrc)
 Sets the maximum STA short retry count (SSRC). More...
 
void SetPsMode (const Mac48Address &address, bool isInPsMode)
 Register whether the STA is in Power Save mode or not. More...
 
void SetQosSupport (Mac48Address from, bool qosSupported)
 Records QoS support of the remote station. More...
 
void SetRtsCtsThreshold (uint32_t threshold)
 Sets the RTS threshold. More...
 
void SetShortPreambleEnabled (bool enable)
 Enable or disable short PHY preambles. More...
 
void SetShortSlotTimeEnabled (bool enable)
 Enable or disable short slot time. More...
 
void SetUseNonErpProtection (bool enable)
 Enable or disable protection for non-ERP stations. More...
 
void SetUseNonHtProtection (bool enable)
 Enable or disable protection for non-HT stations. More...
 
bool UseLdpcForDestination (Mac48Address dest) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Private Types

typedef std::vector< std::pair< Time, WifiMode > > TxTime
 typedef for a vector of a pair of Time, WifiMode. More...
 

Private Member Functions

void AddCalcTxTime (WifiMode mode, Time t)
 Add transmission time for the given mode to an internal list. More...
 
void CheckInit (RrpaaWifiRemoteStation *station)
 Check for initializations. More...
 
void CheckTimeout (RrpaaWifiRemoteStation *station)
 Check if the counter should be reset. More...
 
WifiRemoteStationDoCreateStation () const override
 
WifiTxVector DoGetDataTxVector (WifiRemoteStation *station, uint16_t allowedWidth) override
 
WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station) override
 
void DoInitialize () override
 Initialize() implementation. More...
 
bool DoNeedRts (WifiRemoteStation *st, uint32_t size, bool normally) override
 
void DoReportDataFailed (WifiRemoteStation *station) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportFinalDataFailed (WifiRemoteStation *station) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportFinalRtsFailed (WifiRemoteStation *station) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRtsFailed (WifiRemoteStation *station) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRtsOk (WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
Time GetCalcTxTime (WifiMode mode) const
 Get the estimated TxTime of a packet with a given mode. More...
 
WifiRrpaaThresholds GetThresholds (RrpaaWifiRemoteStation *station, uint8_t index) const
 Get the thresholds for the given station and mode index. More...
 
WifiRrpaaThresholds GetThresholds (RrpaaWifiRemoteStation *station, WifiMode mode) const
 Get the thresholds for the given station and mode. More...
 
void InitThresholds (RrpaaWifiRemoteStation *station)
 Initialize the thresholds internal list for the given station. More...
 
void ResetCountersBasic (RrpaaWifiRemoteStation *station)
 Reset the counters of the given station. More...
 
void RunAdaptiveRtsAlgorithm (RrpaaWifiRemoteStation *station)
 Run an enhanced algorithm which activates the use of RTS for the given station if the conditions are met. More...
 
void RunBasicAlgorithm (RrpaaWifiRemoteStation *station)
 Find an appropriate rate and power for the given station, using a basic algorithm. More...
 

Private Attributes

uint32_t m_ackLength
 Ack frame length used to calculate mode TxTime (in bytes). More...
 
double m_alpha
 Alpha value for RRPAA (value for calculating MTL threshold) More...
 
bool m_basic
 If using the basic algorithm (without RTS/CTS). More...
 
double m_beta
 Beta value for RRPAA (value for calculating ORI threshold). More...
 
TxTime m_calcTxTime
 To hold all the calculated TxTime for all modes. More...
 
double m_delta
 Delta value for RRPAA (value for pdTable increments). More...
 
Time m_difs
 Value of DIFS configured in the device. More...
 
uint32_t m_frameLength
 Data frame length used to calculate mode TxTime (in bytes). More...
 
double m_gamma
 Gamma value for RRPAA (value for pdTable decrements). More...
 
uint8_t m_maxPowerLevel
 Maximal power level. More...
 
uint8_t m_minPowerLevel
 Differently form rate, power levels do not depend on the remote station. More...
 
uint8_t m_nPowerLevels
 Number of power levels. More...
 
TracedCallback< double, double, Mac48Addressm_powerChange
 The trace source fired when the transmission power change. More...
 
TracedCallback< DataRate, DataRate, Mac48Addressm_rateChange
 The trace source fired when the transmission rate change. More...
 
Time m_sifs
 Value of SIFS configured in the device. More...
 
double m_tau
 Tau value for RRPAA (value for calculating EWND size). More...
 
Time m_timeout
 Timeout for the RRAA BASIC loss estimation block. More...
 
Ptr< UniformRandomVariablem_uniformRandomVariable
 Provides uniform random variables for probabilistic changes. More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 74 of file rrpaa-wifi-manager.h.

Member Typedef Documentation

◆ TxTime

typedef std::vector<std::pair<Time, WifiMode> > ns3::RrpaaWifiManager::TxTime
private

typedef for a vector of a pair of Time, WifiMode.

Essentially a list for WifiMode and its corresponding transmission time to transmit a reference packet.

Definition at line 202 of file rrpaa-wifi-manager.h.

Constructor & Destructor Documentation

◆ RrpaaWifiManager()

ns3::RrpaaWifiManager::RrpaaWifiManager ( )

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

References m_uniformRandomVariable, and NS_LOG_FUNCTION.

◆ ~RrpaaWifiManager()

ns3::RrpaaWifiManager::~RrpaaWifiManager ( )
override

Definition at line 135 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddCalcTxTime()

void ns3::RrpaaWifiManager::AddCalcTxTime ( WifiMode  mode,
Time  t 
)
private

Add transmission time for the given mode to an internal list.

Parameters
modethe WifiMode
ttransmission time

Definition at line 213 of file rrpaa-wifi-manager.cc.

References m_calcTxTime, and NS_LOG_FUNCTION.

Referenced by SetupPhy().

+ Here is the caller graph for this function:

◆ AssignStreams()

int64_t ns3::RrpaaWifiManager::AssignStreams ( int64_t  stream)
overridevirtual

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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 141 of file rrpaa-wifi-manager.cc.

References m_uniformRandomVariable, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ CheckInit()

◆ CheckTimeout()

void ns3::RrpaaWifiManager::CheckTimeout ( RrpaaWifiRemoteStation station)
private

Check if the counter should be reset.

Parameters
stationthe remote station

Definition at line 483 of file rrpaa-wifi-manager.cc.

References ns3::RrpaaWifiRemoteStation::m_counter, ns3::RrpaaWifiRemoteStation::m_lastReset, m_timeout, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ResetCountersBasic().

Referenced by DoReportDataFailed(), and DoReportDataOk().

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

◆ DoCreateStation()

WifiRemoteStation * ns3::RrpaaWifiManager::DoCreateStation ( ) const
overrideprivatevirtual
Returns
a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 236 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoGetDataTxVector()

WifiTxVector ns3::RrpaaWifiManager::DoGetDataTxVector ( WifiRemoteStation station,
uint16_t  allowedWidth 
)
overrideprivatevirtual
Parameters
stationthe station that we need to communicate
allowedWidththe allowed width in MHz 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.

Implements ns3::WifiRemoteStationManager.

Definition at line 400 of file rrpaa-wifi-manager.cc.

References CheckInit(), ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiMode::GetDataRate(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiPhy::GetPowerDbm(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), ns3::WifiRemoteStationManager::GetSupported(), m_powerChange, m_rateChange, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoGetRtsTxVector()

WifiTxVector ns3::RrpaaWifiManager::DoGetRtsTxVector ( WifiRemoteStation station)
overrideprivatevirtual
Parameters
stationthe 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.

Implements ns3::WifiRemoteStationManager.

Definition at line 438 of file rrpaa-wifi-manager.cc.

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

+ Here is the call graph for this function:

◆ DoInitialize()

void ns3::RrpaaWifiManager::DoInitialize ( void  )
overrideprivatevirtual

Initialize() implementation.

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

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

Reimplemented from ns3::Object.

Definition at line 180 of file rrpaa-wifi-manager.cc.

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

+ Here is the call graph for this function:

◆ DoNeedRts()

bool ns3::RrpaaWifiManager::DoNeedRts ( WifiRemoteStation station,
uint32_t  size,
bool  normally 
)
overrideprivatevirtual
Parameters
stationthe station that we need to communicate
sizethe size of the frame to send in bytes
normallyindicates 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 from ns3::WifiRemoteStationManager.

Definition at line 469 of file rrpaa-wifi-manager.cc.

References CheckInit(), m_basic, NS_LOG_FUNCTION, and RunAdaptiveRtsAlgorithm().

+ Here is the call graph for this function:

◆ DoReportDataFailed()

void ns3::RrpaaWifiManager::DoReportDataFailed ( WifiRemoteStation station)
overrideprivatevirtual

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

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 343 of file rrpaa-wifi-manager.cc.

References CheckInit(), CheckTimeout(), NS_LOG_FUNCTION, and RunBasicAlgorithm().

+ Here is the call graph for this function:

◆ DoReportDataOk()

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

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

This allows different types of WifiRemoteStationManager to respond differently,

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

Implements ns3::WifiRemoteStationManager.

Definition at line 371 of file rrpaa-wifi-manager.cc.

References CheckInit(), CheckTimeout(), NS_LOG_FUNCTION, and RunBasicAlgorithm().

+ Here is the call graph for this function:

◆ DoReportFinalDataFailed()

void ns3::RrpaaWifiManager::DoReportFinalDataFailed ( WifiRemoteStation station)
overrideprivatevirtual

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

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 394 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportFinalRtsFailed()

void ns3::RrpaaWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation station)
overrideprivatevirtual

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

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 388 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsFailed()

void ns3::RrpaaWifiManager::DoReportRtsFailed ( WifiRemoteStation station)
overrideprivatevirtual

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

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 337 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsOk()

void ns3::RrpaaWifiManager::DoReportRtsOk ( WifiRemoteStation station,
double  ctsSnr,
WifiMode  ctsMode,
double  rtsSnr 
)
overrideprivatevirtual

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

This allows different types of WifiRemoteStationManager to respond differently,

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

Implements ns3::WifiRemoteStationManager.

Definition at line 362 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRxOk()

void ns3::RrpaaWifiManager::DoReportRxOk ( WifiRemoteStation station,
double  rxSnr,
WifiMode  txMode 
)
overrideprivatevirtual

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

This allows different types of WifiRemoteStationManager to respond differently,

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

Implements ns3::WifiRemoteStationManager.

Definition at line 356 of file rrpaa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ GetCalcTxTime()

Time ns3::RrpaaWifiManager::GetCalcTxTime ( WifiMode  mode) const
private

Get the estimated TxTime of a packet with a given mode.

Parameters
modethe WifiMode
Returns
the estimated TX time

Definition at line 198 of file rrpaa-wifi-manager.cc.

References m_calcTxTime, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Seconds().

Referenced by InitThresholds().

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

◆ GetThresholds() [1/2]

WifiRrpaaThresholds ns3::RrpaaWifiManager::GetThresholds ( RrpaaWifiRemoteStation station,
uint8_t  index 
) const
private

Get the thresholds for the given station and mode index.

Parameters
stationthe remote station
indexthe mode index in the supported rates
Returns
the RRPAA thresholds

Definition at line 638 of file rrpaa-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetSupported(), GetThresholds(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetThresholds() [2/2]

WifiRrpaaThresholds ns3::RrpaaWifiManager::GetThresholds ( RrpaaWifiRemoteStation station,
WifiMode  mode 
) const
private

Get the thresholds for the given station and mode.

Parameters
stationthe remote station
modethe WifiMode
Returns
the RRPAA thresholds

Definition at line 220 of file rrpaa-wifi-manager.cc.

References ns3::RrpaaWifiRemoteStation::m_thresholds, NS_ABORT_MSG, and NS_LOG_FUNCTION.

Referenced by GetThresholds(), ResetCountersBasic(), and RunBasicAlgorithm().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ InitThresholds()

void ns3::RrpaaWifiManager::InitThresholds ( RrpaaWifiRemoteStation station)
private

Initialize the thresholds internal list for the given station.

Parameters
stationthe remote station

Definition at line 290 of file rrpaa-wifi-manager.cc.

References GetCalcTxTime(), ns3::Time::GetSeconds(), ns3::WifiRemoteStationManager::GetSupported(), m_alpha, m_beta, m_difs, ns3::WifiRrpaaThresholds::m_ewnd, ns3::WifiRrpaaThresholds::m_mtl, ns3::RrpaaWifiRemoteStation::m_nRate, ns3::WifiRrpaaThresholds::m_ori, m_sifs, m_tau, ns3::RrpaaWifiRemoteStation::m_thresholds, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by CheckInit().

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

◆ ResetCountersBasic()

void ns3::RrpaaWifiManager::ResetCountersBasic ( RrpaaWifiRemoteStation station)
private

Reset the counters of the given station.

Parameters
stationthe remote station

Definition at line 328 of file rrpaa-wifi-manager.cc.

References GetThresholds(), ns3::RrpaaWifiRemoteStation::m_counter, ns3::WifiRrpaaThresholds::m_ewnd, ns3::RrpaaWifiRemoteStation::m_lastReset, ns3::RrpaaWifiRemoteStation::m_nFailed, ns3::RrpaaWifiRemoteStation::m_rateIndex, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by CheckInit(), CheckTimeout(), and RunBasicAlgorithm().

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

◆ RunAdaptiveRtsAlgorithm()

void ns3::RrpaaWifiManager::RunAdaptiveRtsAlgorithm ( RrpaaWifiRemoteStation station)
private

Run an enhanced algorithm which activates the use of RTS for the given station if the conditions are met.

Parameters
stationthe remote station

Definition at line 612 of file rrpaa-wifi-manager.cc.

References ns3::RrpaaWifiRemoteStation::m_adaptiveRtsOn, ns3::RrpaaWifiRemoteStation::m_adaptiveRtsWnd, ns3::RrpaaWifiRemoteStation::m_lastFrameFail, ns3::RrpaaWifiRemoteStation::m_rtsCounter, and NS_LOG_FUNCTION.

Referenced by DoNeedRts().

+ Here is the caller graph for this function:

◆ RunBasicAlgorithm()

◆ SetupMac()

void ns3::RrpaaWifiManager::SetupMac ( const Ptr< WifiMac mac)
overridevirtual

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

IFS).

Parameters
macthe MAC of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 173 of file rrpaa-wifi-manager.cc.

References third::mac, NS_LOG_FUNCTION, and ns3::WifiRemoteStationManager::SetupMac().

+ Here is the call graph for this function:

◆ SetupPhy()

void ns3::RrpaaWifiManager::SetupPhy ( const Ptr< WifiPhy phy)
overridevirtual

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

Parameters
phythe PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 149 of file rrpaa-wifi-manager.cc.

References AddCalcTxTime(), m_ackLength, m_difs, m_frameLength, m_maxPowerLevel, m_minPowerLevel, m_nPowerLevels, m_sifs, NS_LOG_DEBUG, NS_LOG_FUNCTION, third::phy, ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetPreambleType(), ns3::WifiRemoteStationManager::SetupPhy(), and ns3::WIFI_PREAMBLE_LONG.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_ackLength

uint32_t ns3::RrpaaWifiManager::m_ackLength
private

Ack frame length used to calculate mode TxTime (in bytes).

Definition at line 209 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and SetupPhy().

◆ m_alpha

double ns3::RrpaaWifiManager::m_alpha
private

Alpha value for RRPAA (value for calculating MTL threshold)

Definition at line 213 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and InitThresholds().

◆ m_basic

bool ns3::RrpaaWifiManager::m_basic
private

If using the basic algorithm (without RTS/CTS).

Definition at line 211 of file rrpaa-wifi-manager.h.

Referenced by DoNeedRts(), and GetTypeId().

◆ m_beta

double ns3::RrpaaWifiManager::m_beta
private

Beta value for RRPAA (value for calculating ORI threshold).

Definition at line 214 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and InitThresholds().

◆ m_calcTxTime

TxTime ns3::RrpaaWifiManager::m_calcTxTime
private

To hold all the calculated TxTime for all modes.

Definition at line 204 of file rrpaa-wifi-manager.h.

Referenced by AddCalcTxTime(), and GetCalcTxTime().

◆ m_delta

double ns3::RrpaaWifiManager::m_delta
private

Delta value for RRPAA (value for pdTable increments).

Definition at line 217 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and RunBasicAlgorithm().

◆ m_difs

Time ns3::RrpaaWifiManager::m_difs
private

Value of DIFS configured in the device.

Definition at line 206 of file rrpaa-wifi-manager.h.

Referenced by InitThresholds(), and SetupPhy().

◆ m_frameLength

uint32_t ns3::RrpaaWifiManager::m_frameLength
private

Data frame length used to calculate mode TxTime (in bytes).

Definition at line 208 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and SetupPhy().

◆ m_gamma

double ns3::RrpaaWifiManager::m_gamma
private

Gamma value for RRPAA (value for pdTable decrements).

Definition at line 216 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and RunBasicAlgorithm().

◆ m_maxPowerLevel

uint8_t ns3::RrpaaWifiManager::m_maxPowerLevel
private

Maximal power level.

Definition at line 224 of file rrpaa-wifi-manager.h.

Referenced by CheckInit(), RunBasicAlgorithm(), and SetupPhy().

◆ m_minPowerLevel

uint8_t ns3::RrpaaWifiManager::m_minPowerLevel
private

Differently form rate, power levels do not depend on the remote station.

The levels depend only on the physical layer of the device. Minimal power level.

Definition at line 223 of file rrpaa-wifi-manager.h.

Referenced by RunBasicAlgorithm(), and SetupPhy().

◆ m_nPowerLevels

uint8_t ns3::RrpaaWifiManager::m_nPowerLevels
private

Number of power levels.

Definition at line 225 of file rrpaa-wifi-manager.h.

Referenced by CheckInit(), and SetupPhy().

◆ m_powerChange

TracedCallback<double, double, Mac48Address> ns3::RrpaaWifiManager::m_powerChange
private

The trace source fired when the transmission power change.

Definition at line 230 of file rrpaa-wifi-manager.h.

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

◆ m_rateChange

TracedCallback<DataRate, DataRate, Mac48Address> ns3::RrpaaWifiManager::m_rateChange
private

The trace source fired when the transmission rate change.

Definition at line 234 of file rrpaa-wifi-manager.h.

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

◆ m_sifs

Time ns3::RrpaaWifiManager::m_sifs
private

Value of SIFS configured in the device.

Definition at line 205 of file rrpaa-wifi-manager.h.

Referenced by InitThresholds(), and SetupPhy().

◆ m_tau

double ns3::RrpaaWifiManager::m_tau
private

Tau value for RRPAA (value for calculating EWND size).

Definition at line 215 of file rrpaa-wifi-manager.h.

Referenced by GetTypeId(), and InitThresholds().

◆ m_timeout

Time ns3::RrpaaWifiManager::m_timeout
private

Timeout for the RRAA BASIC loss estimation block.

Definition at line 212 of file rrpaa-wifi-manager.h.

Referenced by CheckTimeout(), and GetTypeId().

◆ m_uniformRandomVariable

Ptr<UniformRandomVariable> ns3::RrpaaWifiManager::m_uniformRandomVariable
private

Provides uniform random variables for probabilistic changes.

Definition at line 237 of file rrpaa-wifi-manager.h.

Referenced by RrpaaWifiManager(), AssignStreams(), and RunBasicAlgorithm().


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