create PHY objects More...

#include "wifi-helper.h"

Inheritance diagram for ns3::WifiPhyHelper:

Collaboration diagram for ns3::WifiPhyHelper:

Public Types
enum	SupportedPcapDataLinkTypes { DLT_IEEE802_11 , DLT_PRISM_HEADER , DLT_IEEE802_11_RADIO }
	An enumeration of the pcap data link types (DLTs) which this helper supports. More...

Public Member Functions
	WifiPhyHelper (uint8_t nLinks=1)
	Constructor. More...

	~WifiPhyHelper () override

virtual std::vector< Ptr< WifiPhy > >	Create (Ptr< Node > node, Ptr< WifiNetDevice > device) const =0

void	DisablePreambleDetectionModel ()
	Disable the preamble detection model on all links. More...

PcapHelper::DataLinkType	GetPcapDataLinkType () const
	Get the data link type of PCAP traces to be used. More...

void	Set (std::string name, const AttributeValue &v)

void	Set (uint8_t linkId, std::string name, const AttributeValue &v)

template<typename... Args>
void	SetErrorRateModel (std::string type, Args &&... args)
	Helper function used to set the error rate model. More...

template<typename... Args>
void	SetErrorRateModel (uint8_t linkId, std::string type, Args &&... args)

template<typename... Args>
void	SetFrameCaptureModel (std::string type, Args &&... args)
	Helper function used to set the frame capture model. More...

template<typename... Args>
void	SetFrameCaptureModel (uint8_t linkId, std::string type, Args &&... args)

template<typename... Args>
void	SetInterferenceHelper (std::string type, Args &&... args)
	Helper function used to set the interference helper. More...

void	SetPcapDataLinkType (SupportedPcapDataLinkTypes dlt)
	Set the data link type of PCAP traces to be used. More...

template<typename... Args>
void	SetPreambleDetectionModel (std::string type, Args &&... args)
	Helper function used to set the preamble detection model. More...

template<typename... Args>
void	SetPreambleDetectionModel (uint8_t linkId, std::string type, Args &&... args)

Public Member Functions inherited from ns3::PcapHelperForDevice
	PcapHelperForDevice ()
	Construct a PcapHelperForDevice. More...

virtual	~PcapHelperForDevice ()
	Destroy a PcapHelperForDevice. More...

void	EnablePcap (std::string prefix, NetDeviceContainer d, bool promiscuous=false)
	Enable pcap output on each device in the container which is of the appropriate type. More...

void	EnablePcap (std::string prefix, NodeContainer n, bool promiscuous=false)
	Enable pcap output on each device (which is of the appropriate type) in the nodes provided in the container. More...

void	EnablePcap (std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
	Enable pcap output the indicated net device. More...

void	EnablePcap (std::string prefix, std::string ndName, bool promiscuous=false, bool explicitFilename=false)
	Enable pcap output the indicated net device using a device previously named using the ns-3 object name service. More...

void	EnablePcap (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool promiscuous=false)
	Enable pcap output on the device specified by a global node-id (of a previously created node) and associated device-id. More...

void	EnablePcapAll (std::string prefix, bool promiscuous=false)
	Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created in the simulation. More...

Public Member Functions inherited from ns3::AsciiTraceHelperForDevice
	AsciiTraceHelperForDevice ()
	Construct an AsciiTraceHelperForDevice. More...

virtual	~AsciiTraceHelperForDevice ()
	Destroy an AsciiTraceHelperForDevice. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, Ptr< NetDevice > nd)
	Enable ascii trace output on the indicated net device. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, std::string ndName)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t deviceid)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id. More...

void	EnableAscii (std::string prefix, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type. More...

void	EnableAscii (std::string prefix, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container. More...

void	EnableAscii (std::string prefix, Ptr< NetDevice > nd, bool explicitFilename=false)
	Enable ascii trace output on the indicated net device. More...

void	EnableAscii (std::string prefix, std::string ndName, bool explicitFilename=false)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service. More...

void	EnableAscii (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id. More...

void	EnableAsciiAll (Ptr< OutputStreamWrapper > stream)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation. More...

void	EnableAsciiAll (std::string prefix)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation. More...

Static Protected Member Functions
static void	PcapSniffRxEvent (Ptr< PcapFileWrapper > file, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, SignalNoiseDbm signalNoise, uint16_t staId=SU_STA_ID)

static void	PcapSniffTxEvent (Ptr< PcapFileWrapper > file, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, uint16_t staId=SU_STA_ID)

Protected Attributes
std::vector< ObjectFactory >	m_errorRateModel
	error rate model More...

std::vector< ObjectFactory >	m_frameCaptureModel
	frame capture model More...

ObjectFactory	m_interferenceHelper
	interference helper More...

std::vector< ObjectFactory >	m_phys
	PHY objects. More...

std::vector< ObjectFactory >	m_preambleDetectionModel
	preamble detection model More...

Private Member Functions
void	EnableAsciiInternal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename) override
	Enable ASCII trace output on the indicated net device. More...

void	EnablePcapInternal (std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename) override
	Enable pcap output the indicated net device. More...

Static Private Member Functions
static void	GetRadiotapHeader (RadiotapHeader &header, Ptr< Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, uint16_t staId)
	Get the Radiotap header for a transmitted packet. More...

static void	GetRadiotapHeader (RadiotapHeader &header, Ptr< Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, uint16_t staId, SignalNoiseDbm signalNoise)
	Get the Radiotap header for a received packet. More...

Private Attributes
PcapHelper::DataLinkType	m_pcapDlt
	PCAP data link type. More...

Detailed Description

create PHY objects

This base class must be implemented by new PHY implementation which wish to integrate with the ns3::WifiHelper class.

Definition at line 48 of file wifi-helper.h.

Member Enumeration Documentation

◆ SupportedPcapDataLinkTypes

enum ns3::WifiPhyHelper::SupportedPcapDataLinkTypes

An enumeration of the pcap data link types (DLTs) which this helper supports.

See http://wiki.wireshark.org/Development/LibpcapFileFormat for more information on these formats.

Enumerator
DLT_IEEE802_11	IEEE 802.11 Wireless LAN headers on packets.
DLT_PRISM_HEADER	Include Prism monitor mode information.
DLT_IEEE802_11_RADIO	Include Radiotap link layer information.

Definition at line 172 of file wifi-helper.h.

Constructor & Destructor Documentation

◆ WifiPhyHelper()

ns3::WifiPhyHelper::WifiPhyHelper ( uint8_t nLinks = 1 )

Constructor.

Parameters

nLinks the number of links to configure (>1 only for 11be devices)

Definition at line 146 of file wifi-helper.cc.

References m_errorRateModel, m_frameCaptureModel, m_phys, m_preambleDetectionModel, NS_ABORT_IF, and SetPreambleDetectionModel().

Here is the call graph for this function:

◆ ~WifiPhyHelper()

ns3::WifiPhyHelper::~WifiPhyHelper ( )

override

Definition at line 158 of file wifi-helper.cc.

Member Function Documentation

◆ Create()

virtual std::vector<Ptr<WifiPhy> > ns3::WifiPhyHelper::Create	(	Ptr< Node >	node,
		Ptr< WifiNetDevice >	device
	)		const

pure virtual

Parameters

node	the node on which the PHY object(s) will reside
device	the device within which the PHY object(s) will reside

Returns: new PHY objects.

Subclasses must implement this method to allow the ns3::WifiHelper class to create PHY objects from ns3::WifiHelper::Install.

Implemented in ns3::YansWifiPhyHelper, and ns3::SpectrumWifiPhyHelper.

Referenced by ns3::MeshHelper::CreateInterface(), and ns3::WifiHelper::Install().

Here is the caller graph for this function:

◆ DisablePreambleDetectionModel()

void ns3::WifiPhyHelper::DisablePreambleDetectionModel ( )

Disable the preamble detection model on all links.

Definition at line 178 of file wifi-helper.cc.

References m_preambleDetectionModel.

Referenced by ChainRegressionTest::CreateDevices(), Bug772ChainTest::CreateDevices(), HwmpProactiveRegressionTest::CreateDevices(), HwmpReactiveRegressionTest::CreateDevices(), HwmpDoRfRegressionTest::CreateDevices(), and FlameRegressionTest::CreateDevices().

Here is the caller graph for this function:

◆ EnableAsciiInternal()

void ns3::WifiPhyHelper::EnableAsciiInternal	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	explicitFilename
	)

overrideprivatevirtual

Enable ASCII trace output on the indicated net device.

NetDevice-specific implementation mechanism for hooking the trace and writing to the trace file.

Parameters

stream	The output stream object to use when logging ASCII traces.
prefix	Filename prefix to use for ASCII trace files.
nd	Net device for which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::AsciiTraceHelperForDevice.

Definition at line 624 of file wifi-helper.cc.

References ns3::AsciiPhyReceiveSinkWithContext(), ns3::AsciiPhyReceiveSinkWithoutContext(), ns3::AsciiPhyTransmitSinkWithContext(), ns3::AsciiPhyTransmitSinkWithoutContext(), ns3::Config::Connect(), ns3::Config::ConnectWithoutContext(), ns3::AsciiTraceHelper::CreateFileStream(), ns3::Packet::EnablePrinting(), ns3::AsciiTraceHelper::GetFilenameFromDevice(), ns3::WifiNetDevice::GetNPhys(), ns3::MakeBoundCallback(), NS_LOG_INFO, and nlohmann::to_string().

Here is the call graph for this function:

◆ EnablePcapInternal()

void ns3::WifiPhyHelper::EnablePcapInternal	(	std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	promiscuous,
		bool	explicitFilename
	)

overrideprivatevirtual

Enable pcap output the indicated net device.

NetDevice-specific implementation mechanism for hooking the trace and writing to the trace file.

Parameters

prefix	Filename prefix to use for pcap files.
nd	Net device for which you want to enable tracing.
promiscuous	If true capture all possible packets available at the device.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::PcapHelperForDevice.

Definition at line 568 of file wifi-helper.cc.

References ns3::PcapHelper::CreateFile(), create-module::file, ns3::PcapHelper::GetFilenameFromDevice(), ns3::WifiNetDevice::GetNPhys(), ns3::WifiNetDevice::GetPhys(), m_pcapDlt, ns3::MakeBoundCallback(), NS_ABORT_MSG_IF, NS_LOG_FUNCTION, NS_LOG_INFO, PcapSniffRxEvent(), PcapSniffTxEvent(), third::phy, and nlohmann::to_string().

Here is the call graph for this function:

◆ GetPcapDataLinkType()

PcapHelper::DataLinkType ns3::WifiPhyHelper::GetPcapDataLinkType ( ) const

Get the data link type of PCAP traces to be used.

See also: SupportedPcapDataLinkTypes

Returns: The data link type of the pcap file (and packets) to be used

Definition at line 562 of file wifi-helper.cc.

References m_pcapDlt.

◆ GetRadiotapHeader() [1/2]

void ns3::WifiPhyHelper::GetRadiotapHeader	(	RadiotapHeader &	header,
		Ptr< Packet >	packet,
		uint16_t	channelFreqMhz,
		WifiTxVector	txVector,
		MpduInfo	aMpdu,
		uint16_t	staId
	)

staticprivate

Get the Radiotap header for a transmitted packet.

Parameters

header	the radiotap header to be filled in
packet	the packet
channelFreqMhz	the channel frequency
txVector	the TXVECTOR
aMpdu	the A-MPDU information
staId	the STA-ID

Definition at line 264 of file wifi-helper.cc.

Referenced by GetRadiotapHeader(), PcapSniffRxEvent(), and PcapSniffTxEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRadiotapHeader() [2/2]

void ns3::WifiPhyHelper::GetRadiotapHeader	(	RadiotapHeader &	header,
		Ptr< Packet >	packet,
		uint16_t	channelFreqMhz,
		WifiTxVector	txVector,
		MpduInfo	aMpdu,
		uint16_t	staId,
		SignalNoiseDbm	signalNoise
	)

staticprivate

Get the Radiotap header for a received packet.

Parameters

header	the radiotap header to be filled in
packet	the packet
channelFreqMhz	the channel frequency
txVector	the TXVECTOR
aMpdu	the A-MPDU information
staId	the STA-ID
signalNoise	the rx signal and noise information

Definition at line 250 of file wifi-helper.cc.

References GetRadiotapHeader(), ns3::SignalNoiseDbm::noise, ns3::RadiotapHeader::SetAntennaNoisePower(), ns3::RadiotapHeader::SetAntennaSignalPower(), and ns3::SignalNoiseDbm::signal.

Here is the call graph for this function:

◆ PcapSniffRxEvent()

void ns3::WifiPhyHelper::PcapSniffRxEvent	(	Ptr< PcapFileWrapper >	file,
		Ptr< const Packet >	packet,
		uint16_t	channelFreqMhz,
		WifiTxVector	txVector,
		MpduInfo	aMpdu,
		SignalNoiseDbm	signalNoise,
		uint16_t	staId = `SU_STA_ID`
	)

staticprotected

Parameters

file	the pcap file wrapper
packet	the packet
channelFreqMhz	the channel frequency
txVector	the TXVECTOR
aMpdu	the A-MPDU information
signalNoise	the RX signal and noise information
staId	the STA-ID (only used for MU)

Handle RX pcap.

Definition at line 218 of file wifi-helper.cc.

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::PcapHelper::DLT_IEEE802_11, ns3::PcapHelper::DLT_IEEE802_11_RADIO, ns3::PcapHelper::DLT_PRISM_HEADER, create-module::file, GetRadiotapHeader(), ns3::Simulator::Now(), NS_ABORT_MSG, and NS_FATAL_ERROR.

Referenced by EnablePcapInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PcapSniffTxEvent()

void ns3::WifiPhyHelper::PcapSniffTxEvent	(	Ptr< PcapFileWrapper >	file,
		Ptr< const Packet >	packet,
		uint16_t	channelFreqMhz,
		WifiTxVector	txVector,
		MpduInfo	aMpdu,
		uint16_t	staId = `SU_STA_ID`
	)

staticprotected

Parameters

file	the pcap file wrapper
packet	the packet
channelFreqMhz	the channel frequency
txVector	the TXVECTOR
aMpdu	the A-MPDU information
staId	the STA-ID (only used for MU)

Handle TX pcap.

Definition at line 187 of file wifi-helper.cc.

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::PcapHelper::DLT_IEEE802_11, ns3::PcapHelper::DLT_IEEE802_11_RADIO, ns3::PcapHelper::DLT_PRISM_HEADER, create-module::file, GetRadiotapHeader(), ns3::Simulator::Now(), NS_ABORT_MSG, and NS_FATAL_ERROR.

Referenced by EnablePcapInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set() [1/2]

void ns3::WifiPhyHelper::Set	(	std::string	name,
		const AttributeValue &	v
	)

Parameters

name	the name of the attribute to set
v	the value of the attribute

Set an attribute of all the underlying PHY object.

Definition at line 163 of file wifi-helper.cc.

References m_phys, and third::phy.

Referenced by BatteryLifetimeTest::ConstantLoadTest(), Bug772ChainTest::CreateDevices(), BasicEnergyDepletionTest::DepletionTestCase(), SpectrumWifiPhyInterfacesHelperTest::DoRun(), Bug2843TestCase::DoRun(), SpectrumWifiPhyMultipleInterfacesTest::DoSetup(), EmlsrOperationsTestBase::DoSetup(), MultiLinkOperationsTestBase::DoSetup(), TestUlOfdmaPowerControl::DoSetup(), RoutingExperiment::Run(), MultiLinkOperationsTestBase::SetChannels(), and BatteryLifetimeTest::VariableLoadTest().

Here is the caller graph for this function:

◆ Set() [2/2]

void ns3::WifiPhyHelper::Set	(	uint8_t	linkId,
		std::string	name,
		const AttributeValue &	v
	)

Parameters

name	the name of the attribute to set
v	the value of the attribute
linkId	ID of the link to configure (>0 only for 11be devices)

Set an attribute of the given underlying PHY object.

Definition at line 172 of file wifi-helper.cc.

References m_phys.

◆ SetErrorRateModel() [1/2]

template<typename... Args>

void ns3::WifiPhyHelper::SetErrorRateModel	(	std::string	type,
		Args &&...	args
	)

Helper function used to set the error rate model.

Template Parameters

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

Parameters

type	the type of error rate model
args	A sequence of name-value pairs of the attributes to set.

Definition at line 550 of file wifi-helper.h.

References check-style-clang-format::args, m_phys, and check-style-clang-format::type.

Referenced by ns3::SpectrumWifiPhyHelper::SpectrumWifiPhyHelper(), ns3::YansWifiPhyHelper::YansWifiPhyHelper(), ChainRegressionTest::CreateDevices(), Bug772ChainTest::CreateDevices(), HwmpProactiveRegressionTest::CreateDevices(), HwmpReactiveRegressionTest::CreateDevices(), HwmpDoRfRegressionTest::CreateDevices(), FlameRegressionTest::CreateDevices(), Bug2843TestCase::DoRun(), and TestUlOfdmaPowerControl::DoSetup().

Here is the caller graph for this function:

◆ SetErrorRateModel() [2/2]

template<typename... Args>

void ns3::WifiPhyHelper::SetErrorRateModel	(	uint8_t	linkId,
		std::string	type,
		Args &&...	args
	)

Template Parameters

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

Parameters

linkId	ID of the link to configure (>0 only for 11be devices)
type	the type of the error rate model to set.
args	A sequence of name-value pairs of the attributes to set.

Set the error rate model and its attributes to use for the given link when Install is called.

Definition at line 560 of file wifi-helper.h.

References check-style-clang-format::args, m_errorRateModel, and check-style-clang-format::type.

◆ SetFrameCaptureModel() [1/2]

template<typename... Args>

void ns3::WifiPhyHelper::SetFrameCaptureModel	(	std::string	type,
		Args &&...	args
	)

Helper function used to set the frame capture model.

Template Parameters

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

Parameters

type	the type of frame capture model
args	A sequence of name-value pairs of the attributes to set.

Definition at line 568 of file wifi-helper.h.

References check-style-clang-format::args, m_phys, and check-style-clang-format::type.

◆ SetFrameCaptureModel() [2/2]

template<typename... Args>

void ns3::WifiPhyHelper::SetFrameCaptureModel	(	uint8_t	linkId,
		std::string	type,
		Args &&...	args
	)

Template Parameters

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

Parameters

linkId	ID of the link to configure (>0 only for 11be devices)
type	the type of the frame capture model to set.
args	A sequence of name-value pairs of the attributes to set.

Set the frame capture model and its attributes to use for the given link when Install is called.

Definition at line 578 of file wifi-helper.h.

References check-style-clang-format::args, m_frameCaptureModel, and check-style-clang-format::type.

◆ SetInterferenceHelper()

template<typename... Args>

void ns3::WifiPhyHelper::SetInterferenceHelper	(	std::string	type,
		Args &&...	args
	)

Helper function used to set the interference helper.

Template Parameters

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

Parameters

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

Definition at line 542 of file wifi-helper.h.

References check-style-clang-format::args, m_interferenceHelper, ns3::ObjectFactory::Set(), ns3::ObjectFactory::SetTypeId(), and check-style-clang-format::type.

Referenced by ns3::SpectrumWifiPhyHelper::SpectrumWifiPhyHelper(), and ns3::YansWifiPhyHelper::YansWifiPhyHelper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPcapDataLinkType()

void ns3::WifiPhyHelper::SetPcapDataLinkType ( SupportedPcapDataLinkTypes dlt )

Set the data link type of PCAP traces to be used.

This function has to be called before EnablePcap(), so that the header of the pcap file can be written correctly.

See also: SupportedPcapDataLinkTypes

Parameters

dlt	The data link type of the pcap file (and packets) to be used

Definition at line 543 of file wifi-helper.cc.

References ns3::PcapHelper::DLT_IEEE802_11, DLT_IEEE802_11, ns3::PcapHelper::DLT_IEEE802_11_RADIO, DLT_IEEE802_11_RADIO, ns3::PcapHelper::DLT_PRISM_HEADER, DLT_PRISM_HEADER, m_pcapDlt, and NS_ABORT_MSG.

Referenced by BatteryLifetimeTest::ConstantLoadTest(), BasicEnergyDepletionTest::DepletionTestCase(), WifiMsduAggregatorThroughputTest::DoRun(), SpectrumWifiPhyMultipleInterfacesTest::DoSetup(), EmlsrOperationsTestBase::DoSetup(), MultiLinkOperationsTestBase::SetChannels(), and BatteryLifetimeTest::VariableLoadTest().

Here is the caller graph for this function:

◆ SetPreambleDetectionModel() [1/2]

template<typename... Args>

void ns3::WifiPhyHelper::SetPreambleDetectionModel	(	std::string	type,
		Args &&...	args
	)

Helper function used to set the preamble detection model.

Template Parameters

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

Parameters

type	the type of preamble detection model
args	A sequence of name-value pairs of the attributes to set.

Definition at line 586 of file wifi-helper.h.

References check-style-clang-format::args, m_phys, and check-style-clang-format::type.

Referenced by WifiPhyHelper().

Here is the caller graph for this function:

◆ SetPreambleDetectionModel() [2/2]

template<typename... Args>

void ns3::WifiPhyHelper::SetPreambleDetectionModel	(	uint8_t	linkId,
		std::string	type,
		Args &&...	args
	)

Template Parameters

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

Parameters

linkId	ID of the link to configure (>0 only for 11be devices)
type	the type of the preamble detection model to set.
args	A sequence of name-value pairs of the attributes to set.

Set the preamble detection model and its attributes to use for the given link when Install is called.

Definition at line 596 of file wifi-helper.h.

References check-style-clang-format::args, m_preambleDetectionModel, and check-style-clang-format::type.

Member Data Documentation

◆ m_errorRateModel

std::vector<ObjectFactory> ns3::WifiPhyHelper::m_errorRateModel

protected

error rate model

Definition at line 240 of file wifi-helper.h.

Referenced by WifiPhyHelper(), ns3::SpectrumWifiPhyHelper::Create(), ns3::YansWifiPhyHelper::Create(), and SetErrorRateModel().

◆ m_frameCaptureModel

std::vector<ObjectFactory> ns3::WifiPhyHelper::m_frameCaptureModel

protected

frame capture model

Definition at line 241 of file wifi-helper.h.

Referenced by WifiPhyHelper(), ns3::SpectrumWifiPhyHelper::Create(), ns3::YansWifiPhyHelper::Create(), and SetFrameCaptureModel().

◆ m_interferenceHelper

ObjectFactory ns3::WifiPhyHelper::m_interferenceHelper

protected

interference helper

Definition at line 239 of file wifi-helper.h.

Referenced by ns3::SpectrumWifiPhyHelper::Create(), ns3::YansWifiPhyHelper::Create(), and SetInterferenceHelper().

◆ m_pcapDlt

PcapHelper::DataLinkType ns3::WifiPhyHelper::m_pcapDlt

private

PCAP data link type.

Definition at line 313 of file wifi-helper.h.

Referenced by EnablePcapInternal(), GetPcapDataLinkType(), and SetPcapDataLinkType().

◆ m_phys

std::vector<ObjectFactory> ns3::WifiPhyHelper::m_phys

protected

PHY objects.

Definition at line 238 of file wifi-helper.h.

Referenced by ns3::SpectrumWifiPhyHelper::SpectrumWifiPhyHelper(), WifiPhyHelper(), ns3::YansWifiPhyHelper::YansWifiPhyHelper(), ns3::SpectrumWifiPhyHelper::Create(), ns3::YansWifiPhyHelper::Create(), Set(), SetErrorRateModel(), SetFrameCaptureModel(), and SetPreambleDetectionModel().

◆ m_preambleDetectionModel

std::vector<ObjectFactory> ns3::WifiPhyHelper::m_preambleDetectionModel

protected

preamble detection model

Definition at line 242 of file wifi-helper.h.

Referenced by WifiPhyHelper(), ns3::SpectrumWifiPhyHelper::Create(), ns3::YansWifiPhyHelper::Create(), DisablePreambleDetectionModel(), and SetPreambleDetectionModel().

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

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

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ SupportedPcapDataLinkTypes

Constructor & Destructor Documentation

◆ WifiPhyHelper()

◆ ~WifiPhyHelper()

Member Function Documentation

◆ Create()

◆ DisablePreambleDetectionModel()

◆ EnableAsciiInternal()

◆ EnablePcapInternal()

◆ GetPcapDataLinkType()

◆ GetRadiotapHeader() [1/2]

◆ GetRadiotapHeader() [2/2]

◆ PcapSniffRxEvent()

◆ PcapSniffTxEvent()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetErrorRateModel() [1/2]

◆ SetErrorRateModel() [2/2]

◆ SetFrameCaptureModel() [1/2]

◆ SetFrameCaptureModel() [2/2]

◆ SetInterferenceHelper()

◆ SetPcapDataLinkType()

◆ SetPreambleDetectionModel() [1/2]

◆ SetPreambleDetectionModel() [2/2]

Member Data Documentation

◆ m_errorRateModel

◆ m_frameCaptureModel

◆ m_interferenceHelper

◆ m_pcapDlt

◆ m_phys

◆ m_preambleDetectionModel