Make it easy to create and manage PHY objects for the spectrum model. More...

#include "spectrum-wifi-helper.h"

Inheritance diagram for ns3::SpectrumWifiPhyHelper:

Collaboration diagram for ns3::SpectrumWifiPhyHelper:

Public Member Functions
	SpectrumWifiPhyHelper (uint8_t nLinks=1)
	Create a PHY helper.

void	AddChannel (const Ptr< SpectrumChannel > channel, const FrequencyRange &freqRange=WHOLE_WIFI_SPECTRUM)

void	AddChannel (const std::string &channelName, const FrequencyRange &freqRange=WHOLE_WIFI_SPECTRUM)

void	SetChannel (const Ptr< SpectrumChannel > channel)

void	SetChannel (const std::string &channelName)

Public Member Functions inherited from ns3::WifiPhyHelper
	WifiPhyHelper (uint8_t nLinks=1)
	Constructor.

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

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

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.

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.

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.

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

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

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

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

virtual	~PcapHelperForDevice ()
	Destroy a PcapHelperForDevice.

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.

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.

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

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.

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.

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.

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

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

virtual	~AsciiTraceHelperForDevice ()
	Destroy an AsciiTraceHelperForDevice.

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

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.

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

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.

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.

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

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.

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

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.

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.

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.

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.

virtual void	EnableAsciiInternal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)=0
	Enable ascii trace output on the indicated net device.

Private Member Functions
void	AddWifiBandwidthFilter (Ptr< SpectrumChannel > channel)

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

Private Attributes
std::map< FrequencyRange, Ptr< SpectrumChannel > >	m_channels
	the spectrum channels

Additional Inherited Members
Public Types inherited from ns3::WifiPhyHelper
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...

Static Protected Member Functions inherited from ns3::WifiPhyHelper
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 inherited from ns3::WifiPhyHelper
std::vector< ObjectFactory >	m_errorRateModel
	error rate model

std::vector< ObjectFactory >	m_frameCaptureModel
	frame capture model

ObjectFactory	m_interferenceHelper
	interference helper

std::vector< ObjectFactory >	m_phy
	PHY object.

std::vector< ObjectFactory >	m_preambleDetectionModel
	preamble detection model

Detailed Description

Make it easy to create and manage PHY objects for the spectrum model.

The Pcap and ASCII traces generated by the EnableAscii and EnablePcap methods defined in this class correspond to PHY-level traces and come to us via WifiPhyHelper

This helper will install an instance of a WifiBandwidthFilter on any SpectrumChannel added to this helper (via one of the SetChannel methods), unless one has previously been installed on the channel object.

Definition at line 40 of file spectrum-wifi-helper.h.

Constructor & Destructor Documentation

◆ SpectrumWifiPhyHelper()

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

Create a PHY helper.

Parameters

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

Definition at line 42 of file spectrum-wifi-helper.cc.

References ns3::WifiPhyHelper::m_phy, NS_ABORT_IF, ns3::WifiPhyHelper::SetErrorRateModel(), and ns3::WifiPhyHelper::SetInterferenceHelper().

Here is the call graph for this function:

Member Function Documentation

◆ AddChannel() [1/2]

void ns3::SpectrumWifiPhyHelper::AddChannel	(	const Ptr< SpectrumChannel >	channel,
		const FrequencyRange &	freqRange = `WHOLE_WIFI_SPECTRUM`
	)

Parameters

channel	the spectrum channel to add to this helper
freqRange	the frequency range, bounded by a minFrequency and a maxFrequency in MHz

Every PHY created by a call to Install is added to this spectrum channel. If a PHY is requested to operate or scan a channel with the specified frequency and width combination, it will activate that channel and deactivate the current channel for that PHY.

Definition at line 70 of file spectrum-wifi-helper.cc.

References AddWifiBandwidthFilter(), and m_channels.

Referenced by EmlsrOperationsTestBase::DoSetup(), and MultiLinkOperationsTestBase::SetChannels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddChannel() [2/2]

void ns3::SpectrumWifiPhyHelper::AddChannel	(	const std::string &	channelName,
		const FrequencyRange &	freqRange = `WHOLE_WIFI_SPECTRUM`
	)

Parameters

channelName	The name of the spectrum channel to add to this helper
freqRange	the frequency range, bounded by a minFrequency and a maxFrequency in MHz

Every PHY created by a call to Install is added to this spectrum channel. If a PHY is requested to operate or scan a channel with the specified frequency and width combination, it will activate that channel and deactivate the current channel for that PHY.

Definition at line 78 of file spectrum-wifi-helper.cc.

References AddChannel(), and AddWifiBandwidthFilter().

Referenced by AddChannel().

Here is the call graph for this function: