create MAC layers for a ns3::WifiNetDevice. More...

#include "wifi-mac-helper.h"

Collaboration diagram for ns3::WifiMacHelper:

Public Member Functions
	WifiMacHelper ()
	Create a WifiMacHelper to make life easier for people who want to work with Wifi MAC layers.
virtual	~WifiMacHelper ()
	Destroy a WifiMacHelper.
virtual Ptr< WifiMac >	Create (Ptr< WifiNetDevice > device, WifiStandard standard) const
template<typename... Args>
void	SetAckManager (std::string type, Args &&... args)
	Helper function used to set the Acknowledgment Manager.
template<typename... Args>
void	SetApEmlsrManager (std::string type, Args &&... args)
	Helper function used to set the AP EMLSR Manager that can be installed on an EHT AP MLD.
template<typename... Args>
void	SetAssocManager (std::string type, Args &&... args)
	Helper function used to set the Association Manager.
template<typename... Args>
void	SetChannelAccessManager (Args &&... args)
	Helper function used to set the Channel Access Manager object.
template<typename... Args>
void	SetDcf (Args &&... args)
	Helper function used to create and set the Txop object.
template<typename... Args>
void	SetEdca (AcIndex aci, Args &&... args)
	Helper function used to create and set the QosTxop object corresponding to the given AC.
template<typename... Args>
void	SetEmlsrManager (std::string type, Args &&... args)
	Helper function used to set the EMLSR Manager that can be installed on an EHT non-AP MLD.
template<typename... Args>
void	SetFrameExchangeManager (Args &&... args)
	Helper function used to set the Frame Exchange Manager object.
template<typename... Args>
void	SetGcrManager (std::string type, Args &&... args)
	Helper function used to set the GCR Manager that can be installed on a QoS AP.
template<typename... Args>
void	SetMacQueueScheduler (std::string type, Args &&... args)
	Helper function used to set the MAC queue scheduler.
template<typename... Args>
void	SetMultiUserScheduler (std::string type, Args &&... args)
	Helper function used to set the Multi User Scheduler that can be aggregated to an HE AP's MAC.
template<typename... Args>
void	SetPowerSaveManager (std::string type, Args &&... args)
	Helper function used to set the Power Save Manager.
template<typename... Args>
void	SetProtectionManager (std::string type, Args &&... args)
	Helper function used to set the Protection Manager.
template<typename... Args>
void	SetType (std::string type, Args &&... args)

Protected Attributes
ObjectFactory	m_ackManager
	Factory to create an acknowledgment manager.
ObjectFactory	m_apEmlsrManager
	AP EMLSR Manager object factory.
ObjectFactory	m_assocManager
	Association Manager.
ObjectFactory	m_channelAccessManager
	Channel Access Manager object factory.
ObjectFactory	m_dcf
	Txop (DCF) object factory.
std::map< AcIndex, ObjectFactory, std::greater<> >	m_edca
	QosTxop (EDCA) object factories.
ObjectFactory	m_emlsrManager
	EMLSR Manager object factory.
ObjectFactory	m_frameExchangeManager
	Frame Exchange Manager object factory.
ObjectFactory	m_gcrManager
	GCR Manager object factory.
ObjectFactory	m_mac
	MAC object factory.
ObjectFactory	m_muScheduler
	Multi-user Scheduler object factory.
ObjectFactory	m_powerSaveManager
	Factory to create a power save manager.
ObjectFactory	m_protectionManager
	Factory to create a protection manager.
ObjectFactory	m_queueScheduler
	MAC queue scheduler.

Detailed Description

create MAC layers for a ns3::WifiNetDevice.

This class can create MACs of type ns3::ApWifiMac, ns3::StaWifiMac and ns3::AdhocWifiMac. Its purpose is to allow a WifiHelper to configure and install WifiMac objects on a collection of nodes. The WifiMac objects themselves are mainly composed of TxMiddle, RxMiddle, ChannelAccessManager, FrameExchangeManager, WifiRemoteStationManager, MpduAggregator and MsduAggregartor objects, so this helper offers the opportunity to configure attribute values away from their default values, on a per-NodeContainer basis. By default, it creates an Adhoc MAC layer without QoS. Typically, it is used to set type and attribute values, then hand this object over to the WifiHelper that finishes the job of installing.

This class may be further subclassed (WaveMacHelper is an example of this).

Definition at line 39 of file wifi-mac-helper.h.

Constructor & Destructor Documentation

◆ WifiMacHelper()

ns3::WifiMacHelper::WifiMacHelper ( )

Create a WifiMacHelper to make life easier for people who want to work with Wifi MAC layers.

Definition at line 33 of file wifi-mac-helper.cc.

References ns3::GetFrameExchangeManagerTypeIdName(), m_ackManager, m_apEmlsrManager, m_assocManager, m_channelAccessManager, m_dcf, m_edca, m_emlsrManager, m_frameExchangeManager, m_protectionManager, m_queueScheduler, SetType(), ns3::WIFI_STANDARD_COUNT, and ns3::wifiAcList.

Here is the call graph for this function:

◆ ~WifiMacHelper()

ns3::WifiMacHelper::~WifiMacHelper ( )

virtual

Destroy a WifiMacHelper.

Definition at line 57 of file wifi-mac-helper.cc.

Member Function Documentation

◆ Create()

Ptr< WifiMac > ns3::WifiMacHelper::Create	(	Ptr< WifiNetDevice >	device,
		WifiStandard	standard ) const

virtual

Parameters

device	the device within which the MAC object will reside
standard	the standard to configure during installation

Returns: a new MAC object.

This allows the ns3::WifiHelper class to create MAC objects from ns3::WifiHelper::Install.

Definition at line 62 of file wifi-mac-helper.cc.

References ns3::AC_BE_NQOS, ns3::Object::AggregateObject(), ns3::Mac48Address::Allocate(), ns3::ObjectFactory::Create(), ns3::DynamicCast(), ns3::GetFrameExchangeManagerTypeIdName(), m_ackManager, m_apEmlsrManager, m_assocManager, m_channelAccessManager, m_dcf, m_edca, m_emlsrManager, m_frameExchangeManager, m_gcrManager, m_mac, m_muScheduler, m_powerSaveManager, m_protectionManager, m_queueScheduler, ns3::ML_SETUP, NS_ABORT_MSG_IF, ns3::ObjectFactory::Set(), ns3::WifiAckManager::SetWifiMac(), ns3::WifiProtectionManager::SetWifiMac(), ns3::WIFI_STANDARD_80211ax, ns3::WIFI_STANDARD_80211be, ns3::WIFI_STANDARD_80211n, and ns3::WIFI_STANDARD_UNSPECIFIED.

Referenced by ns3::WifiHelper::Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAckManager()

template<typename... Args>

void ns3::WifiMacHelper::SetAckManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the Acknowledgment Manager.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of Acknowledgment Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 290 of file wifi-mac-helper.h.

References m_ackManager.

◆ SetApEmlsrManager()

template<typename... Args>

void ns3::WifiMacHelper::SetApEmlsrManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the AP EMLSR Manager that can be installed on an EHT AP MLD.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of AP EMLSR Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 322 of file wifi-mac-helper.h.

References m_apEmlsrManager.

◆ SetAssocManager()

template<typename... Args>

void ns3::WifiMacHelper::SetAssocManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the Association Manager.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of Association Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 266 of file wifi-mac-helper.h.

References m_assocManager.

◆ SetChannelAccessManager()

template<typename... Args>

void ns3::WifiMacHelper::SetChannelAccessManager ( Args &&... args )

Helper function used to set the Channel Access Manager object.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

args	A sequence of name-value pairs of the attributes to set.

Definition at line 252 of file wifi-mac-helper.h.

References m_channelAccessManager.

◆ SetDcf()

template<typename... Args>

void ns3::WifiMacHelper::SetDcf ( Args &&... args )

Helper function used to create and set the Txop object.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

args	A sequence of name-value pairs of the attributes to set.

Definition at line 236 of file wifi-mac-helper.h.

References m_dcf.

◆ SetEdca()

template<typename... Args>

void ns3::WifiMacHelper::SetEdca	(	AcIndex	aci,
		Args &&...	args )

Helper function used to create and set the QosTxop object corresponding to the given AC.

Parameters

aci	the AC index

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

args	A sequence of name-value pairs of the attributes to set.

Definition at line 243 of file wifi-mac-helper.h.

References m_edca, and NS_ASSERT_MSG.

◆ SetEmlsrManager()

template<typename... Args>

void ns3::WifiMacHelper::SetEmlsrManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the EMLSR Manager that can be installed on an EHT non-AP MLD.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of EMLSR Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 314 of file wifi-mac-helper.h.

References m_emlsrManager.

Referenced by WifiStaticEmlsrTest::GetClientMacHelper().

Here is the caller graph for this function:

◆ SetFrameExchangeManager()

template<typename... Args>

void ns3::WifiMacHelper::SetFrameExchangeManager ( Args &&... args )

Helper function used to set the Frame Exchange Manager object.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

args	A sequence of name-value pairs of the attributes to set.

Definition at line 259 of file wifi-mac-helper.h.

References m_frameExchangeManager.

◆ SetGcrManager()

template<typename... Args>

void ns3::WifiMacHelper::SetGcrManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the GCR Manager that can be installed on a QoS AP.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of GCR Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 330 of file wifi-mac-helper.h.

References m_gcrManager.

Referenced by GcrBaTest::ConfigureGcrManager(), and GcrUrTest::ConfigureGcrManager().

Here is the caller graph for this function:

◆ SetMacQueueScheduler()

template<typename... Args>

void ns3::WifiMacHelper::SetMacQueueScheduler	(	std::string	type,
		Args &&...	args )

Helper function used to set the MAC queue scheduler.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of MAC queue scheduler
args	A sequence of name-value pairs of the attributes to set.

Definition at line 274 of file wifi-mac-helper.h.

References m_queueScheduler.

◆ SetMultiUserScheduler()

template<typename... Args>

void ns3::WifiMacHelper::SetMultiUserScheduler	(	std::string	type,
		Args &&...	args )

Helper function used to set the Multi User Scheduler that can be aggregated to an HE AP's MAC.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of Multi User Scheduler
args	A sequence of name-value pairs of the attributes to set.

Definition at line 306 of file wifi-mac-helper.h.

References m_muScheduler.

Referenced by WifiStaticInfraBssTest::GetApMacHelper().

Here is the caller graph for this function:

◆ SetPowerSaveManager()

template<typename... Args>

void ns3::WifiMacHelper::SetPowerSaveManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the Power Save Manager.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of Power Save Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 298 of file wifi-mac-helper.h.

References m_powerSaveManager.

Referenced by WifiStaticEmlsrTest::GetClientMacHelper(), and WifiStaticInfraBssTest::GetClientMacHelper().

Here is the caller graph for this function:

◆ SetProtectionManager()

template<typename... Args>

void ns3::WifiMacHelper::SetProtectionManager	(	std::string	type,
		Args &&...	args )

Helper function used to set the Protection Manager.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of Protection Manager
args	A sequence of name-value pairs of the attributes to set.

Definition at line 282 of file wifi-mac-helper.h.

References m_protectionManager.

◆ SetType()

template<typename... Args>

void ns3::WifiMacHelper::SetType	(	std::string	type,
		Args &&...	args )

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs.

Parameters

type	the type of ns3::WifiMac to create.
args	A sequence of name-value pairs of the attributes to set.

All the attributes specified in this method should exist in the requested MAC.

Definition at line 228 of file wifi-mac-helper.h.

References m_mac.

Referenced by WifiMacHelper(), BatteryLifetimeTest::ConstantLoadTest(), AodvExample::CreateDevices(), Bug772ChainTest::CreateDevices(), ChainRegressionTest::CreateDevices(), DsdvManetExample::CreateDevices(), TracerouteExample::CreateDevices(), BasicEnergyDepletionTest::DepletionTestCase(), ns3::aodv::LoopbackTestCase::DoRun(), SetChannelFrequencyTest::DoRun(), WifiAcMappingTest::DoRun(), WifiMsduAggregatorThroughputTest::DoRun(), WifiUseAvailBwTest::DoRun(), GcrTestBase::DoSetup(), experiment(), WifiStaticEmlsrTest::GetApMacHelper(), WifiStaticInfraBssTest::GetApMacHelper(), WifiStaticEmlsrTest::GetClientMacHelper(), WifiStaticInfraBssTest::GetClientMacHelper(), RoutingExperiment::Run(), and BatteryLifetimeTest::VariableLoadTest().

Here is the caller graph for this function:

Member Data Documentation

◆ m_ackManager

ObjectFactory ns3::WifiMacHelper::m_ackManager

protected

Factory to create an acknowledgment manager.

Definition at line 209 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetAckManager().

◆ m_apEmlsrManager

ObjectFactory ns3::WifiMacHelper::m_apEmlsrManager

protected

AP EMLSR Manager object factory.

Definition at line 213 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetApEmlsrManager().

◆ m_assocManager

ObjectFactory ns3::WifiMacHelper::m_assocManager

protected

Association Manager.

Definition at line 206 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetAssocManager().

◆ m_channelAccessManager

ObjectFactory ns3::WifiMacHelper::m_channelAccessManager

protected

Channel Access Manager object factory.

Definition at line 204 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetChannelAccessManager().

◆ m_dcf

ObjectFactory ns3::WifiMacHelper::m_dcf

protected

Txop (DCF) object factory.

Definition at line 202 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetDcf().

◆ m_edca

std::map<AcIndex, ObjectFactory, std::greater<> > ns3::WifiMacHelper::m_edca

protected

QosTxop (EDCA) object factories.

Definition at line 203 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetEdca().

◆ m_emlsrManager

ObjectFactory ns3::WifiMacHelper::m_emlsrManager

protected

EMLSR Manager object factory.

Definition at line 212 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetEmlsrManager().

◆ m_frameExchangeManager

ObjectFactory ns3::WifiMacHelper::m_frameExchangeManager

protected

Frame Exchange Manager object factory.

Definition at line 205 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetFrameExchangeManager().

◆ m_gcrManager

ObjectFactory ns3::WifiMacHelper::m_gcrManager

protected

GCR Manager object factory.

Definition at line 214 of file wifi-mac-helper.h.

Referenced by Create(), and SetGcrManager().

◆ m_mac

ObjectFactory ns3::WifiMacHelper::m_mac

protected

MAC object factory.

Definition at line 201 of file wifi-mac-helper.h.

Referenced by Create(), and SetType().

◆ m_muScheduler

ObjectFactory ns3::WifiMacHelper::m_muScheduler

protected

Multi-user Scheduler object factory.

Definition at line 211 of file wifi-mac-helper.h.

Referenced by Create(), and SetMultiUserScheduler().

◆ m_powerSaveManager

ObjectFactory ns3::WifiMacHelper::m_powerSaveManager

protected

Factory to create a power save manager.

Definition at line 210 of file wifi-mac-helper.h.

Referenced by Create(), and SetPowerSaveManager().

◆ m_protectionManager

ObjectFactory ns3::WifiMacHelper::m_protectionManager

protected

Factory to create a protection manager.

Definition at line 208 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetProtectionManager().

◆ m_queueScheduler

ObjectFactory ns3::WifiMacHelper::m_queueScheduler

protected

MAC queue scheduler.

Definition at line 207 of file wifi-mac-helper.h.

Referenced by WifiMacHelper(), Create(), and SetMacQueueScheduler().

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

src/wifi/helper/wifi-mac-helper.h
src/wifi/helper/wifi-mac-helper.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WifiMacHelper()

◆ ~WifiMacHelper()

Member Function Documentation

◆ Create()

◆ SetAckManager()

◆ SetApEmlsrManager()

◆ SetAssocManager()

◆ SetChannelAccessManager()

◆ SetDcf()

◆ SetEdca()

◆ SetEmlsrManager()

◆ SetFrameExchangeManager()

◆ SetGcrManager()

◆ SetMacQueueScheduler()

◆ SetMultiUserScheduler()

◆ SetPowerSaveManager()

◆ SetProtectionManager()

◆ SetType()

Member Data Documentation

◆ m_ackManager

◆ m_apEmlsrManager

◆ m_assocManager

◆ m_channelAccessManager

◆ m_dcf

◆ m_edca

◆ m_emlsrManager

◆ m_frameExchangeManager

◆ m_gcrManager

◆ m_mac

◆ m_muScheduler

◆ m_powerSaveManager

◆ m_protectionManager

◆ m_queueScheduler