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

helps to create wifi 802.11p objects of WifiNetDevice class More...

#include "wifi-80211p-helper.h"

+ Inheritance diagram for ns3::Wifi80211pHelper:
+ Collaboration diagram for ns3::Wifi80211pHelper:

Public Member Functions

 Wifi80211pHelper ()
 
 ~Wifi80211pHelper () override
 
NetDeviceContainer Install (const WifiPhyHelper &phy, const WifiMacHelper &macHelper, NodeContainer c) const override
 
void SetStandard (WifiStandard standard) override
 
- Public Member Functions inherited from ns3::WifiHelper
 WifiHelper ()
 Create a Wifi helper in an empty state: all its parameters must be set before calling ns3::WifiHelper::Install. More...
 
virtual ~WifiHelper ()
 
int64_t AssignStreams (NetDeviceContainer c, int64_t stream)
 Assign a fixed random variable stream number to the random variables used by the PHY and MAC aspects of the Wifi models. More...
 
template<typename... Args>
void ConfigEhtOptions (Args &&... args)
 Helper function used to configure the EHT options listed as attributes of the EhtConfiguration class. More...
 
template<typename... Args>
void ConfigHeOptions (Args &&... args)
 Helper function used to configure the HE options listed as attributes of the HeConfiguration class. More...
 
template<typename... Args>
void ConfigHtOptions (Args &&... args)
 Helper function used to configure the HT options listed as attributes of the HtConfiguration class. More...
 
template<typename... Args>
void ConfigVhtOptions (Args &&... args)
 Helper function used to configure the VHT options listed as attributes of the VhtConfiguration class. More...
 
void DisableFlowControl ()
 Disable flow control only if you know what you are doing. More...
 
virtual NetDeviceContainer Install (const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const
 
virtual NetDeviceContainer Install (const WifiPhyHelper &phy, const WifiMacHelper &mac, Ptr< Node > node) const
 
virtual NetDeviceContainer Install (const WifiPhyHelper &phy, const WifiMacHelper &mac, std::string nodeName) const
 
template<typename... Args>
void SetObssPdAlgorithm (std::string type, Args &&... args)
 Helper function used to set the OBSS-PD algorithm. More...
 
template<typename... Args>
void SetRemoteStationManager (std::string type, Args &&... args)
 Helper function used to set the station manager. More...
 
template<typename... Args>
void SetRemoteStationManager (uint8_t linkId, std::string type, Args &&... args)
 
void SetSelectQueueCallback (SelectQueueCallback f)
 

Static Public Member Functions

static Wifi80211pHelper Default ()
 
static void EnableLogComponents ()
 Helper to enable all WifiNetDevice log components with one statement. More...
 
- Static Public Member Functions inherited from ns3::WifiHelper
static void EnableLogComponents ()
 Helper to enable all WifiNetDevice log components with one statement. More...
 

Additional Inherited Members

- Public Types inherited from ns3::WifiHelper
typedef std::function< std::size_t(Ptr< QueueItem >)> SelectQueueCallback
 Callback invoked to determine the MAC queue selected for a given packet. More...
 
- Protected Attributes inherited from ns3::WifiHelper
ObjectFactory m_ehtConfig
 EHT configuration. More...
 
bool m_enableFlowControl
 whether to enable flow control More...
 
ObjectFactory m_heConfig
 HE configuration. More...
 
ObjectFactory m_htConfig
 HT configuration. More...
 
ObjectFactory m_obssPdAlgorithm
 OBSS_PD algorithm. More...
 
SelectQueueCallback m_selectQueueCallback
 select queue callback More...
 
WifiStandard m_standard
 wifi standard More...
 
std::vector< ObjectFactorym_stationManager
 station manager More...
 
ObjectFactory m_vhtConfig
 VHT configuration. More...
 

Detailed Description

helps to create wifi 802.11p objects of WifiNetDevice class

This class can help to create a large set of similar wifi 802.11p objects and to configure a large set of their attributes during creation.

Definition at line 40 of file wifi-80211p-helper.h.

Constructor & Destructor Documentation

◆ Wifi80211pHelper()

ns3::Wifi80211pHelper::Wifi80211pHelper ( )

Definition at line 35 of file wifi-80211p-helper.cc.

◆ ~Wifi80211pHelper()

ns3::Wifi80211pHelper::~Wifi80211pHelper ( )
override

Definition at line 39 of file wifi-80211p-helper.cc.

Member Function Documentation

◆ Default()

Wifi80211pHelper ns3::Wifi80211pHelper::Default ( )
static
Returns
a new Wifi80211pHelper in a default state

The default state is defined as being an OcbWifiMac MAC layer with constant rate OfdmRate6MbpsBW10MHz and both objects using their default attribute values.

Definition at line 44 of file wifi-80211p-helper.cc.

References ns3::WifiHelper::SetRemoteStationManager(), SetStandard(), and ns3::WIFI_STANDARD_80211p.

+ Here is the call graph for this function:

◆ EnableLogComponents()

void ns3::Wifi80211pHelper::EnableLogComponents ( )
static

Helper to enable all WifiNetDevice log components with one statement.

Definition at line 72 of file wifi-80211p-helper.cc.

References ns3::WifiHelper::EnableLogComponents(), ns3::LOG_LEVEL_ALL, and ns3::LogComponentEnable().

+ Here is the call graph for this function:

◆ Install()

NetDeviceContainer ns3::Wifi80211pHelper::Install ( const WifiPhyHelper phy,
const WifiMacHelper macHelper,
NodeContainer  c 
) const
overridevirtual
Parameters
phythe PHY helper to create PHY objects
macHelperthe MAC helper to create MAC objects
cthe set of nodes on which a wifi device must be created
Returns
a device container which contains all the devices created by this method.

Reimplemented from ns3::WifiHelper.

Definition at line 81 of file wifi-80211p-helper.cc.

References ns3::WifiHelper::Install(), and NS_FATAL_ERROR.

Referenced by OcbWifiMacTestCase::ConfigureOcbMode(), and VanetRoutingExperiment::SetupAdhocDevices().

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

◆ SetStandard()

void ns3::Wifi80211pHelper::SetStandard ( WifiStandard  standard)
overridevirtual
Parameters
standardthe phy standard to configure during installation

Users can only configure 802.11p with 10MHz or 5 MHz channel bandwidth. The default 802.11p standard uses 10MHz.

Reimplemented from ns3::WifiHelper.

Definition at line 59 of file wifi-80211p-helper.cc.

References NS_FATAL_ERROR, ns3::WifiHelper::SetStandard(), and ns3::WIFI_STANDARD_80211p.

Referenced by Default().

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

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