represent a single transmission modeA WifiMode is implemented by a single integer which is used to lookup in a global array the characteristics of the associated transmission mode. More...

#include "wifi-mode.h"

Public Member Functions
	WifiMode ()
	Create an invalid WifiMode. More...

	WifiMode (std::string name)
	Create a WifiMode if the given string represents a valid WifiMode name. More...

WifiCodeRate	GetCodeRate (void) const

uint16_t	GetConstellationSize (void) const

uint64_t	GetDataRate (uint16_t channelWidth, uint16_t guardInterval, uint8_t nss) const

uint64_t	GetDataRate (const WifiTxVector &txVector, uint16_t staId=SU_STA_ID) const

uint64_t	GetDataRate (uint16_t channelWidth) const

uint8_t	GetMcsValue (void) const

WifiModulationClass	GetModulationClass () const

uint64_t	GetNonHtReferenceRate (void) const

uint64_t	GetPhyRate (uint16_t channelWidth, uint16_t guardInterval, uint8_t nss) const

uint64_t	GetPhyRate (const WifiTxVector &txVector, uint16_t staId=SU_STA_ID) const

uint64_t	GetPhyRate (uint16_t channelWidth) const

uint32_t	GetUid (void) const

std::string	GetUniqueName (void) const

bool	IsAllowed (uint16_t channelWidth, uint8_t nss) const

bool	IsHigherCodeRate (WifiMode mode) const

bool	IsHigherDataRate (WifiMode mode) const

bool	IsMandatory (void) const

Private Member Functions
	WifiMode (uint32_t uid)
	Create a WifiMode from a given unique ID. More...

Private Attributes
uint32_t	m_uid
	UID. More...

Friends
class	WifiModeFactory
	allow WifiModeFactory class access More...

Detailed Description

represent a single transmission mode

A WifiMode is implemented by a single integer which is used to lookup in a global array the characteristics of the associated transmission mode.

It is thus extremely cheap to keep a WifiMode variable around.

See also: WifiMode Attribute

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

Constructor & Destructor Documentation

◆ WifiMode() [1/3]

ns3::WifiMode::WifiMode ( )

Create an invalid WifiMode.

Calling any method on the instance created will trigger an assert. This is useful to separate the declaration of a WifiMode variable from its initialization.

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

◆ WifiMode() [2/3]

ns3::WifiMode::WifiMode ( std::string name )

Create a WifiMode if the given string represents a valid WifiMode name.

Parameters

name	std::string of a valid WifiMode name

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

References ns3::WifiModeFactory::GetFactory(), and ns3::WifiModeFactory::Search().

Here is the call graph for this function:

◆ WifiMode() [3/3]

ns3::WifiMode::WifiMode ( uint32_t uid )

private

Create a WifiMode from a given unique ID.

Parameters

uid unique ID

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

Member Function Documentation

◆ GetCodeRate()

WifiCodeRate ns3::WifiMode::GetCodeRate ( void ) const

Returns: the coding rate of this transmission mode

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::WifiModeItem::GetCodeRateCallback, ns3::WifiModeFactory::GetFactory(), and m_uid.

Referenced by ns3::NistErrorRateModel::DoGetChunkSuccessRate(), ns3::YansErrorRateModel::DoGetChunkSuccessRate(), ns3::TableBasedErrorRateModel::GetMcsForMode(), IsHigherCodeRate(), and IsHigherDataRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetConstellationSize()

uint16_t ns3::WifiMode::GetConstellationSize ( void ) const

Returns: the size of the modulation constellation.

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::WifiModeItem::GetConstellationSizeCallback, ns3::WifiModeFactory::GetFactory(), and m_uid.

Referenced by ns3::NistErrorRateModel::DoGetChunkSuccessRate(), ns3::YansErrorRateModel::DoGetChunkSuccessRate(), ns3::TableBasedErrorRateModel::GetMcsForMode(), and IsHigherDataRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataRate() [1/3]

uint64_t ns3::WifiMode::GetDataRate	(	uint16_t	channelWidth,
		uint16_t	guardInterval,
		uint8_t	nss
	)		const

Parameters

channelWidth	the considered channel width in MHz
guardInterval	the considered guard interval duration in nanoseconds
nss	the considered number of streams

Returns: the data bit rate of this signal in bps.

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::WifiModeItem::GetDataRateCallback, ns3::WifiModeFactory::GetFactory(), m_uid, and NS_ASSERT.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataRate() [2/3]

uint64_t ns3::WifiMode::GetDataRate	(	const WifiTxVector &	txVector,
		uint16_t	staId = `SU_STA_ID`
	)		const

Parameters

txVector	the const WifiTxVector& of the signal
staId	the station ID for MU (unused if SU)

Returns: the data bit rate of this signal.

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::WifiModeItem::GetDataRateFromTxVectorCallback, ns3::WifiModeFactory::GetFactory(), and m_uid.

Here is the call graph for this function:

◆ GetDataRate() [3/3]

uint64_t ns3::WifiMode::GetDataRate ( uint16_t channelWidth ) const

Parameters

channelWidth the considered channel width in MHz

Returns: the data bit rate of this non-HT.

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

References GetDataRate().

Here is the call graph for this function:

◆ GetMcsValue()

uint8_t ns3::WifiMode::GetMcsValue ( void ) const

Returns: the MCS value.

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::GetFactory(), m_uid, ns3::WifiModeFactory::WifiModeItem::mcsValue, ns3::WifiModeFactory::WifiModeItem::modClass, NS_ASSERT, and ns3::WIFI_MOD_CLASS_HT.

Referenced by ns3::WifiRemoteStationManager::AddBasicMcs(), ns3::IdealWifiManager::BuildSnrThresholds(), ns3::ConstantRateWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), TableBasedErrorRateTestCase::DoRun(), ns3::VhtPhy::GetDataRateFromTxVector(), ns3::HePhy::GetDataRateFromTxVector(), ns3::HtPhy::GetDataRateFromTxVector(), ns3::ApWifiMac::GetHtOperation(), ns3::TableBasedErrorRateModel::GetMcsForMode(), ns3::VhtPhy::GetNumberBccEncoders(), ns3::VhtPhy::GetPhyRateFromTxVector(), ns3::HePhy::GetPhyRateFromTxVector(), ns3::HtPhy::GetPhyRateFromTxVector(), ns3::WifiPhyHelper::GetRadiotapHeader(), ns3::HtPpdu::HtPpdu(), ns3::MinstrelHtWifiManager::RateInit(), ns3::ApWifiMac::Receive(), ns3::HePpdu::SetPhyHeaders(), and ns3::VhtPpdu::VhtPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetModulationClass()

WifiModulationClass ns3::WifiMode::GetModulationClass ( ) const

Returns: the Modulation Class (Section 9.7.8 "Modulation classes"; IEEE 802.11-2012) to which this WifiMode belongs.

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::GetFactory(), m_uid, and ns3::WifiModeFactory::WifiModeItem::modClass.

Here is the call graph for this function:

◆ GetNonHtReferenceRate()

uint64_t ns3::WifiMode::GetNonHtReferenceRate ( void ) const

Returns: the rate (in bps) of the non-HT Reference Rate which corresponds to the HT MCS of this WifiMode.

To convert an HT MCS to is corresponding non-HT Reference Rate use the modulation and coding rate of the HT MCS and lookup in Table 9-5 of IEEE 802.11-2012.

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

References ns3::WifiModeFactory::Get(), ns3::WifiModeFactory::GetFactory(), ns3::WifiModeFactory::WifiModeItem::GetNonHtReferenceRateCallback, ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_uid, and NS_ASSERT_MSG.

Referenced by ns3::MinstrelHtWifiManager::DoGetRtsTxVector().

Here is the call graph for this function: