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

#include "wifi-mode.h"

Collaboration diagram for ns3::WifiModeFactory:

Classes
struct	WifiModeItem
	This is the data associated to a unique WifiMode. More...

Static Public Member Functions
static WifiMode	CreateWifiMcs (std::string uniqueName, uint8_t mcsValue, WifiModulationClass modClass)

static WifiMode	CreateWifiMode (std::string uniqueName, WifiModulationClass modClass, bool isMandatory, WifiCodeRate codingRate, uint16_t constellationSize)

Private Types
typedef std::vector< WifiModeItem >	WifiModeItemList
	typedef for a vector of WifiModeItem. More...

Private Member Functions
	WifiModeFactory ()

uint32_t	AllocateUid (std::string uniqueUid)
	Allocate a WifiModeItem from a given uniqueUid. More...

WifiModeItem *	Get (uint32_t uid)
	Return a WifiModeItem at the given UID index. More...

WifiMode	Search (std::string name) const
	Search and return WifiMode from a given name. More...

Static Private Member Functions
static WifiModeFactory *	GetFactory ()
	Return a WifiModeFactory. More...

Private Attributes
WifiModeItemList	m_itemList
	item list More...

Friends
std::istream &	operator>> (std::istream &is, WifiMode &mode)
	Serialize WifiMode from istream (human-readable). More...

class	WifiMode
	allow WifiMode class access More...

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.

Definition at line 298 of file wifi-mode.h.

Member Typedef Documentation

◆ WifiModeItemList

typedef std::vector<WifiModeItem> ns3::WifiModeFactory::WifiModeItemList

private

typedef for a vector of WifiModeItem.

Definition at line 394 of file wifi-mode.h.

Constructor & Destructor Documentation

◆ WifiModeFactory()

ns3::WifiModeFactory::WifiModeFactory ( )

private

Definition at line 669 of file wifi-mode.cc.

Member Function Documentation

◆ AllocateUid()

uint32_t ns3::WifiModeFactory::AllocateUid ( std::string uniqueUid )

private

Allocate a WifiModeItem from a given uniqueUid.

Parameters

uniqueUid the unique UID

Returns: the allocated UID index

Definition at line 769 of file wifi-mode.cc.

References m_itemList.

Referenced by CreateWifiMcs(), CreateWifiMode(), and GetFactory().

Here is the caller graph for this function:

◆ CreateWifiMcs()

WifiMode ns3::WifiModeFactory::CreateWifiMcs	(	std::string	uniqueName,
		uint8_t	mcsValue,
		WifiModulationClass	modClass
	)

static

Parameters

uniqueName	the name of the associated WifiMode. This name must be unique across all instances.
mcsValue	the MCS value
modClass	the class of modulation

Returns: WifiMode

Create a HT WifiMode.

Definition at line 712 of file wifi-mode.cc.

References AllocateUid(), ns3::WifiModeFactory::WifiModeItem::codingRate, ns3::WifiModeFactory::WifiModeItem::constellationSize, Get(), GetFactory(), ns3::WifiModeFactory::WifiModeItem::isMandatory, ns3::WifiModeFactory::WifiModeItem::mcsValue, ns3::WifiModeFactory::WifiModeItem::modClass, NS_ASSERT, ns3::WifiModeFactory::WifiModeItem::uniqueUid, ns3::WIFI_CODE_RATE_UNDEFINED, ns3::WIFI_MOD_CLASS_HT, and WifiMode.

Here is the call graph for this function:

◆ CreateWifiMode()

WifiMode ns3::WifiModeFactory::CreateWifiMode	(	std::string	uniqueName,
		WifiModulationClass	modClass,
		bool	isMandatory,
		WifiCodeRate	codingRate,
		uint16_t	constellationSize
	)

static

Parameters

uniqueName	the name of the associated WifiMode. This name must be unique across all instances.
modClass	the class of modulation
isMandatory	true if this WifiMode is mandatory, false otherwise.
codingRate	if convolutional coding is used for this rate then this parameter specifies the convolutional coding rate used. If there is no explicit convolutional coding step (e.g., for DSSS rates) then the caller should set this parameter to WIFI_CODE_RATE_UNCODED.
constellationSize	the order of the constellation used.