ns3::WifiModeFactory Class Reference

create WifiMode class instances and keep track of them. More...

#include <wifi-mode.h>

List of all members.

Classes
struct	WifiModeItem
Static Public Member Functions
static WifiMode	CreateBpsk (std::string uniqueName, bool isMandatory, uint32_t bandwidth, uint32_t dataRate, uint32_t phyRate)
static WifiMode	CreateQam (std::string uniqueName, bool isMandatory, uint32_t bandwidth, uint32_t dataRate, uint32_t phyRate, uint8_t constellationSize)
static WifiMode	CreateDbpsk (std::string uniqueName, bool isMandatory, uint32_t bandwidth, uint32_t dataRate, uint32_t phyRate)
static WifiMode	CreateDqpsk (std::string uniqueName, bool isMandatory, uint32_t bandwidth, uint32_t dataRate, uint32_t phyRate)

---

Detailed Description

create WifiMode class instances and keep track of them.

This factory ensures that each WifiMode created has a unique name and assigns to each of them a unique integer.

---

Member Function Documentation

static WifiMode ns3::WifiModeFactory::CreateBpsk	(	std::string	uniqueName,
		bool	isMandatory,
		uint32_t	bandwidth,
		uint32_t	dataRate,
		uint32_t	phyRate
	)			[static]

Parameters:

	uniqueName	the name of the associated WifiMode. This name must be unique accross _all_ instances.
	isMandatory	true if this WifiMode is mandatory, false otherwise.
	bandwidth	the bandwidth (Hz) of the signal generated when the associated WifiMode is used.
	dataRate	the rate (bits/second) at which the user data is transmitted
	phyRate	the rate (bits/second) at which the encoded user data is transmitted The phyRate includes FEC so, is typically higher than the dataRate.

Create a BPSK WifiMode.

static WifiMode ns3::WifiModeFactory::CreateDbpsk	(	std::string	uniqueName,
		bool	isMandatory,
		uint32_t	bandwidth,
		uint32_t	dataRate,
		uint32_t	phyRate
	)			[static]

Parameters:

	uniqueName	the name of the associated WifiMode. This name must be unique accross _all_ instances.
	isMandatory	true if this WifiMode is mandatory, false otherwise.
	bandwidth	the bandwidth (Hz) of the signal generated when the associated WifiMode is used.
	dataRate	the rate (bits/second) at which the user data is transmitted
	phyRate	the rate (bits/second) at which the encoded user data is transmitted The phyRate includes FEC so, is typically higher than the dataRate.

Create a DBPSK WifiMode.

static WifiMode ns3::WifiModeFactory::CreateDqpsk	(	std::string	uniqueName,
		bool	isMandatory,
		uint32_t	bandwidth,
		uint32_t	dataRate,
		uint32_t	phyRate
	)			[static]

Parameters:

	uniqueName	the name of the associated WifiMode. This name must be unique accross _all_ instances.
	isMandatory	true if this WifiMode is mandatory, false otherwise.
	bandwidth	the bandwidth (Hz) of the signal generated when the associated WifiMode is used.
	dataRate	the rate (bits/second) at which the user data is transmitted
	phyRate	the rate (bits/second) at which the encoded user data is transmitted The phyRate includes FEC so, is typically higher than the dataRate.

Create a DQPSK WifiMode.

static WifiMode ns3::WifiModeFactory::CreateQam	(	std::string	uniqueName,
		bool	isMandatory,
		uint32_t	bandwidth,
		uint32_t	dataRate,
		uint32_t	phyRate,
		uint8_t	constellationSize
	)			[static]

Parameters:

	uniqueName	the name of the associated WifiMode. This name must be unique accross _all_ instances.
	isMandatory	true if this WifiMode is mandatory, false otherwise.
	bandwidth	the bandwidth (Hz) of the signal generated when the associated WifiMode is used.
	dataRate	the rate (bits/second) at which the user data is transmitted
	phyRate	the rate (bits/second) at which the encoded user data is transmitted The phyRate includes FEC so, is typically higher than the dataRate.
	constellationSize	the number of elements included in the QAM constellation.

Create a QAM WifiMode.

---

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

• src/devices/wifi/wifi-mode.h