This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters which are to be used for a transmission. More...

#include "wifi-tx-vector.h"

Collaboration diagram for ns3::WifiTxVector:

Public Types
typedef std::map< uint16_t, HeMuUserInfo >	HeMuUserInfoMap
	map of HE MU specific user info parameters indexed by STA-ID More...

Public Member Functions
	WifiTxVector ()

	WifiTxVector (const WifiTxVector &txVector)
	Copy constructor. More...

	WifiTxVector (WifiMode mode, uint8_t powerLevel, WifiPreamble preamble, uint16_t guardInterval, uint8_t nTx, uint8_t nss, uint8_t ness, uint16_t channelWidth, bool aggregation, bool stbc=false, bool ldpc=false, uint8_t bssColor=0, uint16_t length=0, bool triggerResponding=false)
	Create a TXVECTOR with the given parameters. More...

	~WifiTxVector ()

uint8_t	GetBssColor () const
	Get the BSS color. More...

uint16_t	GetChannelWidth () const

ContentChannelAllocation	GetContentChannelAllocation () const
	Get the HE SIG-B content channel STA ID allocation IEEE 802.11ax-2021 27.3.11.8.2 HE-SIG-B content channels. More...

uint8_t	GetEhtPpduType () const
	Get the EHT_PPDU_TYPE parameter. More...

uint16_t	GetGuardInterval () const

HeMuUserInfo	GetHeMuUserInfo (uint16_t staId) const
	Get the HE MU user-specific transmission information for the given STA-ID. More...

HeMuUserInfoMap &	GetHeMuUserInfoMap ()
	Get a reference to the map HE MU user-specific transmission information indexed by STA-ID. More...

const HeMuUserInfoMap &	GetHeMuUserInfoMap () const
	Get a const reference to the map HE MU user-specific transmission information indexed by STA-ID. More...

const std::vector< bool > &	GetInactiveSubchannels () const
	Get the 20 MHz subchannels that are punctured. More...

uint16_t	GetLength () const
	Get the LENGTH field of the L-SIG. More...

WifiMode	GetMode (uint16_t staId=SU_STA_ID) const
	If this TX vector is associated with an SU PPDU, return the selected payload transmission mode. More...

bool	GetModeInitialized () const

WifiModulationClass	GetModulationClass () const
	Get the modulation class specified by this TXVECTOR. More...

uint8_t	GetNess () const

uint8_t	GetNss (uint16_t staId=SU_STA_ID) const
	If this TX vector is associated with an SU PPDU, return the number of spatial streams. More...

uint8_t	GetNssMax () const

uint8_t	GetNTx () const

std::pair< std::size_t, std::size_t >	GetNumRusPerHeSigBContentChannel () const
	Get the number of RUs per HE-SIG-B content channel. More...

WifiPreamble	GetPreambleType () const

HeRu::RuSpec	GetRu (uint16_t staId) const
	Get the RU specification for the STA-ID. More...

const RuAllocation &	GetRuAllocation () const
	Get RU Allocation of SIG-B. More...

WifiMode	GetSigBMode () const
	Get MCS used for SIG-B. More...

uint8_t	GetTxPowerLevel () const

bool	IsAggregation () const
	Checks whether the PSDU contains A-MPDU. More...

bool	IsDlMu () const

bool	IsLdpc () const
	Check if LDPC FEC coding is used or not. More...

bool	IsMu () const

bool	IsNonHtDuplicate () const
	Checks whether this TXVECTOR corresponds to a non-HT duplicate. More...

bool	IsStbc () const
	Check if STBC is used or not. More...

bool	IsTriggerResponding () const
	Return true if the Trigger Responding parameter is set to true, false otherwise. More...

bool	IsUlMu () const

bool	IsValid () const
	The standard disallows certain combinations of WifiMode, number of spatial streams, and channel widths. More...

void	SetAggregation (bool aggregation)
	Sets if PSDU contains A-MPDU. More...

void	SetBssColor (uint8_t color)
	Set the BSS color. More...

void	SetChannelWidth (uint16_t channelWidth)
	Sets the selected channelWidth (in MHz) More...

void	SetEhtPpduType (uint8_t type)
	Set the EHT_PPDU_TYPE parameter. More...

void	SetGuardInterval (uint16_t guardInterval)
	Sets the guard interval duration (in nanoseconds) More...

void	SetHeMuUserInfo (uint16_t staId, HeMuUserInfo userInfo)
	Set the HE MU user-specific transmission information for the given STA-ID. More...

void	SetInactiveSubchannels (const std::vector< bool > &inactiveSubchannels)
	Set the 20 MHz subchannels that are punctured. More...

void	SetLdpc (bool ldpc)
	Sets if LDPC FEC coding is being used. More...

void	SetLength (uint16_t length)
	Set the LENGTH field of the L-SIG. More...

void	SetMode (WifiMode mode)
	Sets the selected payload transmission mode. More...

void	SetMode (WifiMode mode, uint16_t staId)
	Sets the selected payload transmission mode for a given STA ID (for MU only) More...

void	SetNess (uint8_t ness)
	Sets the Ness number. More...

void	SetNss (uint8_t nss)
	Sets the number of Nss. More...

void	SetNss (uint8_t nss, uint16_t staId)
	Sets the number of Nss for MU. More...

void	SetNTx (uint8_t nTx)
	Sets the number of TX antennas. More...

void	SetPreambleType (WifiPreamble preamble)
	Sets the preamble type. More...

void	SetRu (HeRu::RuSpec ru, uint16_t staId)
	Set the RU specification for the STA-ID. More...

void	SetRuAllocation (const RuAllocation &ruAlloc)
	Set RU Allocation of SIG-B common field. More...

void	SetSigBMode (const WifiMode &mode)
	Set the MCS used for SIG-B. More...

void	SetStbc (bool stbc)
	Sets if STBC is being used. More...

void	SetTriggerResponding (bool triggerResponding)
	Set the Trigger Responding parameter to the given value. More...

void	SetTxPowerLevel (uint8_t powerlevel)
	Sets the selected transmission power level. More...

Private Member Functions
RuAllocation	DeriveRuAllocation () const
	Derive the RU allocation from the TXVECTOR for which its RU allocation has not been set yet. More...

Private Attributes
bool	m_aggregation
	Flag whether the PSDU contains A-MPDU. More...

uint8_t	m_bssColor
	BSS color. More...

uint16_t	m_channelWidth
	channel width in MHz More...

uint8_t	m_ehtPpduType
	EHT_PPDU_TYPE per Table 36-1 IEEE 802.11be D2.3. More...

uint16_t	m_guardInterval
	guard interval duration in nanoseconds More...

std::vector< bool >	m_inactiveSubchannels
	Bitmap of inactive subchannels used for preamble puncturing. More...

bool	m_ldpc
	LDPC FEC coding if true, BCC otherwise. More...

uint16_t	m_length
	LENGTH field of the L-SIG. More...

WifiMode	m_mode
	The DATARATE parameter in Table 15-4. More...

bool	m_modeInitialized
	Internal initialization flag. More...

HeMuUserInfoMap	m_muUserInfos
	HE MU specific per-user information indexed by station ID (STA-ID) corresponding to the 11 LSBs of the AID of the recipient STA This list shall be used only for HE MU. More...

uint8_t	m_ness
	number of spatial streams in beamforming More...

uint8_t	m_nss
	number of spatial streams More...

uint8_t	m_nTx
	number of TX antennas More...

WifiPreamble	m_preamble
	preamble More...

RuAllocation	m_ruAllocation
	RU allocations that are going to be carried in SIG-B common field per Table 27-1 IEEE. More...

WifiMode	m_sigBMcs
	MCS_SIG_B per Table 27-1 IEEE 802.11ax-2021. More...

bool	m_stbc
	STBC used or not. More...

bool	m_triggerResponding
	The Trigger Responding parameter. More...

uint8_t	m_txPowerLevel
	The TXPWR_LEVEL parameter in Table 15-4. More...

Detailed Description

This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters which are to be used for a transmission.

See IEEE 802.11-2016 16.2.5 "Transmit PHY", and also 8.3.4.1 "PHY SAP peer-to-peer service primitive parameters".

If this class is constructed with the constructor that takes no arguments, then the client must explicitly set the mode and transmit power level parameters before using them. Default member initializers are provided for the other parameters, to conform to a non-MIMO/long guard configuration, although these may also be explicitly set after object construction.

When used in a infrastructure context, WifiTxVector values should be drawn from WifiRemoteStationManager parameters since rate adaptation is responsible for picking the mode, number of streams, etc., but in the case in which there is no such manager (e.g. mesh), the client still needs to initialize at least the mode and transmit power level appropriately.

Note: the above reference is valid for the DSSS PHY only (clause 16). TXVECTOR is defined also for the other PHYs, however they don't include the TXPWRLVL explicitly in the TXVECTOR. This is somewhat strange, since all PHYs actually have a PMD_TXPWRLVL.request primitive. We decide to include the power level in WifiTxVector for all PHYs, since it serves better our purposes, and furthermore it seems close to the way real devices work (e.g., madwifi).

Definition at line 100 of file wifi-tx-vector.h.

Member Typedef Documentation

◆ HeMuUserInfoMap

typedef std::map<uint16_t , HeMuUserInfo > ns3::WifiTxVector::HeMuUserInfoMap

map of HE MU specific user info parameters indexed by STA-ID

Definition at line 105 of file wifi-tx-vector.h.

Constructor & Destructor Documentation

◆ WifiTxVector() [1/3]

ns3::WifiTxVector::WifiTxVector ( )

Definition at line 34 of file wifi-tx-vector.cc.

◆ ~WifiTxVector()

ns3::WifiTxVector::~WifiTxVector ( )

Definition at line 121 of file wifi-tx-vector.cc.

References m_muUserInfos.

◆ WifiTxVector() [2/3]

ns3::WifiTxVector::WifiTxVector	(	WifiMode	mode,
		uint8_t	powerLevel,
		WifiPreamble	preamble,
		uint16_t	guardInterval,
		uint8_t	nTx,
		uint8_t	nss,
		uint8_t	ness,
		uint16_t	channelWidth,
		bool	aggregation,
		bool	stbc = `false`,
		bool	ldpc = `false`,
		uint8_t	bssColor = `0`,
		uint16_t	length = `0`,
		bool	triggerResponding = `false`
	)

Create a TXVECTOR with the given parameters.

Parameters

mode	WifiMode
powerLevel	transmission power level
preamble	preamble type
guardInterval	the guard interval duration in nanoseconds
nTx	the number of TX antennas
nss	the number of spatial STBC streams (NSS)
ness	the number of extension spatial streams (NESS)
channelWidth	the channel width in MHz
aggregation	enable or disable MPDU aggregation
stbc	enable or disable STBC
ldpc	enable or disable LDPC (BCC is used otherwise)
bssColor	the BSS color
length	the LENGTH field of the L-SIG
triggerResponding	the Trigger Responding parameter

Definition at line 55 of file wifi-tx-vector.cc.

◆ WifiTxVector() [3/3]

ns3::WifiTxVector::WifiTxVector ( const WifiTxVector & txVector )

Copy constructor.

Parameters

txVector the TXVECTOR to copy

Definition at line 90 of file wifi-tx-vector.cc.

References m_muUserInfos.

Member Function Documentation

◆ DeriveRuAllocation()

RuAllocation ns3::WifiTxVector::DeriveRuAllocation ( ) const

private

Derive the RU allocation from the TXVECTOR for which its RU allocation has not been set yet.

This is valid only for allocations of RUs of the same size.

Returns: the RU allocation

Definition at line 707 of file wifi-tx-vector.cc.

References ns3::HeRu::EMPTY_242_TONE_RU, ns3::HeRu::GetBandwidth(), ns3::HeRu::GetEqualizedRuAllocation(), ns3::HeRu::GetRusOfType(), m_channelWidth, m_muUserInfos, NS_ABORT_IF, NS_ASSERT, NS_ASSERT_MSG, ns3::HeRu::RU_26_TONE, and ns3::HeRu::RU_2x996_TONE.

Referenced by GetNumRusPerHeSigBContentChannel(), GetRuAllocation(), and SetRuAllocation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBssColor()

uint8_t ns3::WifiTxVector::GetBssColor ( ) const

Get the BSS color.

Returns: the BSS color

Definition at line 354 of file wifi-tx-vector.cc.

References m_bssColor.

Referenced by ns3::WifiPhyHelper::GetRadiotapHeader(), ns3::HeFrameExchangeManager::IsIntraBssPpdu(), ns3::operator<<(), ns3::HePhy::ProcessSigA(), and ns3::HePpdu::SetHeSigHeader().

Here is the caller graph for this function:

◆ GetChannelWidth()

uint16_t ns3::WifiTxVector::GetChannelWidth ( ) const

Returns: the channel width (in MHz)

Definition at line 185 of file wifi-tx-vector.cc.

References m_channelWidth.

Here is the caller graph for this function:

◆ GetContentChannelAllocation()

ContentChannelAllocation ns3::WifiTxVector::GetContentChannelAllocation ( ) const

Get the HE SIG-B content channel STA ID allocation IEEE 802.11ax-2021 27.3.11.8.2 HE-SIG-B content channels.

Returns: content channel allocation

Definition at line 666 of file wifi-tx-vector.cc.

References m_channelWidth, ns3::HeRu::m_heRuSubcarrierGroups, m_muUserInfos, ns3::HeRu::RU_242_TONE, ns3::HeRu::RU_484_TONE, and ns3::HeRu::RU_996_TONE.

Referenced by ns3::EhtPpdu::EhtPpdu(), and ns3::HePpdu::HePpdu().

Here is the caller graph for this function:

◆ GetEhtPpduType()

uint8_t ns3::WifiTxVector::GetEhtPpduType ( ) const

Get the EHT_PPDU_TYPE parameter.

Returns: the EHT_PPDU_TYPE parameter

Definition at line 423 of file wifi-tx-vector.cc.

References m_ehtPpduType.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ GetGuardInterval()

uint16_t ns3::WifiTxVector::GetGuardInterval ( ) const

Returns: the guard interval duration (in nanoseconds)

Definition at line 191 of file wifi-tx-vector.cc.

References m_guardInterval.

Here is the caller graph for this function:

◆ GetHeMuUserInfo()

HeMuUserInfo ns3::WifiTxVector::GetHeMuUserInfo ( uint16_t staId ) const

Get the HE MU user-specific transmission information for the given STA-ID.

This is applicable only for HE MU.

Parameters

staId the station ID

Returns: the HE MU user-specific transmission information for the given STA-ID

Definition at line 499 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, and NS_ABORT_MSG_IF.

Referenced by ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::WifiPhyHelper::GetRadiotapHeader(), and ns3::HePhy::ProcessSigA().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeMuUserInfoMap() [1/2]

WifiTxVector::HeMuUserInfoMap & ns3::WifiTxVector::GetHeMuUserInfoMap ( )

Get a reference to the map HE MU user-specific transmission information indexed by STA-ID.

This is applicable only for HE MU.

Returns: a reference to the map of HE MU user-specific information indexed by STA-ID

Definition at line 523 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, m_ruAllocation, and NS_ABORT_MSG_IF.

Here is the call graph for this function:

◆ GetHeMuUserInfoMap() [2/2]

const WifiTxVector::HeMuUserInfoMap & ns3::WifiTxVector::GetHeMuUserInfoMap ( ) const

Get a const reference to the map HE MU user-specific transmission information indexed by STA-ID.

This is applicable only for HE MU.

Returns: a const reference to the map of HE MU user-specific information indexed by STA-ID

Definition at line 516 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, and NS_ABORT_MSG_IF.

Referenced by ns3::CtrlTriggerHeader::CtrlTriggerHeader(), ns3::HePpdu::HePpdu(), ns3::HePhy::CalculateTxDuration(), ns3::HeFrameExchangeManager::EndReceiveAmpdu(), ns3::RrMultiUserScheduler::FinalizeTxVector(), ns3::HePhy::GetSigBMode(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), ns3::HePhy::GetWifiConstPsduMap(), ns3::HePhy::IsConfigSupported(), ns3::operator<<(), ns3::HeFrameExchangeManager::PrepareMuBar(), ns3::HeFrameExchangeManager::ReceiveMpdu(), WifiPrimaryChannelsTest::ReceiveUl(), TestMultipleHeTbPreambles::Reset(), MultiLinkMuTxTest::Transmit(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), and ns3::RrMultiUserScheduler::UpdateCredits().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInactiveSubchannels()

const std::vector< bool > & ns3::WifiTxVector::GetInactiveSubchannels ( ) const

Get the 20 MHz subchannels that are punctured.

Returns: the bitmap indexed by the 20 MHz subchannels in ascending order, where each bit indicates whether the corresponding 20 MHz subchannel is punctured or not within the transmission bandwidth

Definition at line 594 of file wifi-tx-vector.cc.

References m_inactiveSubchannels.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ GetLength()

uint16_t ns3::WifiTxVector::GetLength ( ) const

Get the LENGTH field of the L-SIG.

Returns: the LENGTH field of the L-SIG

Definition at line 366 of file wifi-tx-vector.cc.

References m_length.

Referenced by ns3::CtrlTriggerHeader::CtrlTriggerHeader(), ns3::HePhy::CalculateTxDuration(), ns3::operator<<(), and ns3::HePhy::ProcessSigA().

Here is the caller graph for this function:

◆ GetMode()

WifiMode ns3::WifiTxVector::GetMode ( uint16_t staId = SU_STA_ID ) const

If this TX vector is associated with an SU PPDU, return the selected payload transmission mode.

If this TX vector is associated with an MU PPDU, return the transmission mode (MCS) selected for the transmission to the station identified by the given STA-ID.

Parameters

staId the station ID for MU

Returns: the selected payload transmission mode

Definition at line 133 of file wifi-tx-vector.cc.

References ns3::EhtPhy::GetEhtMcs(), ns3::HePhy::GetHeMcs(), ns3::GetModulationClassForPreamble(), IsMu(), m_mode, m_modeInitialized, m_muUserInfos, m_preamble, NS_ABORT_MSG, NS_ABORT_MSG_IF, NS_ASSERT, NS_FATAL_ERROR, ns3::WIFI_MOD_CLASS_EHT, and ns3::WIFI_MOD_CLASS_HE.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetModeInitialized()

bool ns3::WifiTxVector::GetModeInitialized ( ) const

Returns: whether mode has been initialized

Definition at line 127 of file wifi-tx-vector.cc.

References m_modeInitialized.

Referenced by IsValid().

Here is the caller graph for this function:

◆ GetModulationClass()

WifiModulationClass ns3::WifiTxVector::GetModulationClass ( ) const

Get the modulation class specified by this TXVECTOR.

Returns: the Modulation Class specified by this TXVECTOR

Definition at line 159 of file wifi-tx-vector.cc.

References ns3::WifiMode::GetModulationClass(), ns3::GetModulationClassForPreamble(), IsMu(), m_mode, m_modeInitialized, m_muUserInfos, m_preamble, NS_ABORT_MSG_IF, and NS_ASSERT.

Referenced by ns3::HeFrameExchangeManager::CalculateAcknowledgmentTime(), ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::WifiPhy::CalculateTxDuration(), ns3::HePhy::CalculateTxDuration(), ns3::HePhy::ConvertHeTbPpduDurationToLSigLength(), ns3::HePhy::ConvertLSigLengthToHeTbPpduDuration(), ns3::HeFrameExchangeManager::ForwardPsduMapDown(), ns3::HePhy::GetCenterFrequencyForNonOfdmaPart(), ns3::MpduAggregator::GetNextAmpdu(), ns3::MsduAggregator::GetNextAmsdu(), ns3::HePhy::GetNonOfdmaBand(), ns3::WifiPhy::GetPayloadDuration(), ns3::VhtFrameExchangeManager::GetPsduSize(), ns3::HePhy::GetSigBDuration(), ns3::HePhy::GetSigBFieldSize(), ns3::HePhy::GetSigMode(), ns3::WifiTxParameters::GetSize(), ns3::WifiTxParameters::GetSizeIfAddMpdu(), ns3::WifiTxParameters::GetSizeIfAggregateMsdu(), ns3::HePhy::GetTrainingDuration(), ns3::WifiPhy::GetWifiConstPsduMap(), ns3::VhtFrameExchangeManager::GetWifiPsdu(), ns3::HePhy::IsConfigSupported(), IsNonHtDuplicate(), ns3::HtFrameExchangeManager::IsWithinLimitsIfAddMpdu(), ns3::HtFrameExchangeManager::IsWithinLimitsIfAggregateMsdu(), ns3::QosFrameExchangeManager::IsWithinSizeAndTimeLimits(), ns3::WifiRemoteStationManager::NeedRts(), ns3::HePhy::ProcessSigA(), ns3::WifiPhy::Send(), ns3::HeFrameExchangeManager::SendPsduMap(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNess()

uint8_t ns3::WifiTxVector::GetNess ( ) const

Returns: the number of extended spatial streams

Definition at line 233 of file wifi-tx-vector.cc.

References m_ness.

Referenced by ns3::HtPhy::GetDuration(), ns3::WifiPhyHelper::GetRadiotapHeader(), and ns3::operator<<().

Here is the caller graph for this function:

◆ GetNss()

uint8_t ns3::WifiTxVector::GetNss ( uint16_t staId = SU_STA_ID ) const

If this TX vector is associated with an SU PPDU, return the number of spatial streams.

If this TX vector is associated with an MU PPDU, return the number of spatial streams for the transmission to the station identified by the given STA-ID.

Parameters

staId the station ID for MU

Returns: the number of spatial streams

Definition at line 203 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, m_nss, NS_ABORT_MSG_IF, and NS_ASSERT.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNssMax()

uint8_t ns3::WifiTxVector::GetNssMax ( ) const

Returns: the maximum number of Nss (namely if MU)

Definition at line 215 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, and m_nss.

Referenced by ns3::HtPhy::GetDuration(), ns3::HePhy::IsConfigSupported(), and ns3::WifiPhy::Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNTx()

uint8_t ns3::WifiTxVector::GetNTx ( ) const

Returns: the number of TX antennas

Definition at line 197 of file wifi-tx-vector.cc.

References m_nTx.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ GetNumRusPerHeSigBContentChannel()

std::pair< std::size_t, std::size_t > ns3::WifiTxVector::GetNumRusPerHeSigBContentChannel ( ) const

Get the number of RUs per HE-SIG-B content channel.

This is applicable only for MU. MU-MIMO (i.e. multiple stations per RU) is not supported yet. See section 27.3.10.8.3 of IEEE 802.11ax draft 4.0.

Returns: a pair containing the number of RUs in each HE-SIG-B content channel (resp. 1 and 2)

Definition at line 531 of file wifi-tx-vector.cc.

References DeriveRuAllocation(), GetChannelWidth(), GetRuAllocation(), ns3::HeRu::GetRuSpecs(), m_channelWidth, m_ehtPpduType, m_preamble, NS_ASSERT_MSG, and ns3::WIFI_PREAMBLE_EHT_MU.

Referenced by HeSigBDurationTest::DoRun(), and ns3::HePhy::GetSigBFieldSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPreambleType()

WifiPreamble ns3::WifiTxVector::GetPreambleType ( ) const

Returns: the preamble type

Definition at line 179 of file wifi-tx-vector.cc.

References m_preamble.

Referenced by ns3::CtrlTriggerHeader::CtrlTriggerHeader(), ns3::HigherLayerTxVectorTag::HigherLayerTxVectorTag(), TestMultiUserScheduler::ComputeWifiTxVector(), ns3::PhyEntity::EndReceiveField(), ns3::EhtFrameExchangeManager::ForwardPsduDown(), ns3::HeFrameExchangeManager::ForwardPsduMapDown(), ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::WaveFrameExchangeManager::GetDataTxVector(), ns3::EhtPhy::GetDuration(), ns3::HtPhy::GetDuration(), ns3::VhtPhy::GetDuration(), ns3::DsssPhy::GetHeaderDuration(), ns3::DsssPhy::GetHeaderMode(), ns3::PhyEntity::GetPhyHeaderSections(), ns3::DsssPhy::GetPreambleDuration(), ns3::WifiPhyHelper::GetRadiotapHeader(), ns3::VhtPhy::GetSigBDuration(), ns3::HePhy::GetSigBDuration(), ns3::HePhy::GetSigBFieldSize(), ns3::VhtPhy::GetSigBMode(), ns3::HePhy::GetSigBMode(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), ns3::HePhy::GetWifiConstPsduMap(), ns3::QosFrameExchangeManager::IsWithinSizeAndTimeLimits(), ns3::WifiPhyStateHelper::NotifyRxPsduSucceeded(), ns3::operator<<(), ns3::HePhy::ProcessSigA(), TestUlOfdmaPowerControl::ReceiveOkCallbackAtAp(), ns3::HePhy::RxPayloadSucceeded(), ns3::WifiPhyStateHelper::SwitchToTx(), OfdmaAckSequenceTest::Transmit(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the caller graph for this function:

◆ GetRu()

HeRu::RuSpec ns3::WifiTxVector::GetRu ( uint16_t staId ) const

Get the RU specification for the STA-ID.

This is applicable only for MU.

Parameters

staId the station ID

Returns: the RU specification for the STA-ID

Definition at line 483 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, and NS_ABORT_MSG_IF.

Referenced by ns3::HePhy::GetCenterFrequencyForNonOfdmaPart(), ns3::HePhy::GetChannelWidthAndBand(), ns3::EhtPhy::GetDataRateFromTxVector(), ns3::HePhy::GetDataRateFromTxVector(), ns3::HePhy::GetNonOfdmaBand(), ns3::EhtPhy::GetPhyRateFromTxVector(), ns3::HePhy::GetPhyRateFromTxVector(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), ns3::HePpdu::GetTransmissionChannelWidth(), and TestMultipleHeTbPreambles::RxHeTbPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRuAllocation()

const RuAllocation & ns3::WifiTxVector::GetRuAllocation ( ) const

Get RU Allocation of SIG-B.

Returns: 8 bit RU_ALLOCATION per 20 MHz

Definition at line 406 of file wifi-tx-vector.cc.

References DeriveRuAllocation(), ns3::IsDlMu(), m_preamble, and m_ruAllocation.

Referenced by ns3::EhtPpdu::EhtPpdu(), ns3::HePpdu::HePpdu(), and GetNumRusPerHeSigBContentChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSigBMode()

WifiMode ns3::WifiTxVector::GetSigBMode ( ) const

Get MCS used for SIG-B.

Returns: MCS for SIG-B

Definition at line 390 of file wifi-tx-vector.cc.

References m_sigBMcs.

Referenced by ns3::operator<<(), and ns3::HePpdu::SetHeSigHeader().

Here is the caller graph for this function:

◆ GetTxPowerLevel()

uint8_t ns3::WifiTxVector::GetTxPowerLevel ( ) const

Returns: the transmission power level

Definition at line 173 of file wifi-tx-vector.cc.

References m_txPowerLevel.

Referenced by ns3::WaveFrameExchangeManager::GetDataTxVector(), ns3::operator<<(), ns3::WifiPhy::Send(), ns3::WifiPhyStateHelper::SwitchToTx(), PowerRateAdaptationTest::TestAparf(), PowerRateAdaptationTest::TestParf(), and PowerRateAdaptationTest::TestRrpaa().

Here is the caller graph for this function:

◆ IsAggregation()

bool ns3::WifiTxVector::IsAggregation ( ) const

Checks whether the PSDU contains A-MPDU.

Returns: true if this PSDU has A-MPDU aggregation, false otherwise

Definition at line 239 of file wifi-tx-vector.cc.

References m_aggregation.

Referenced by ns3::WifiPhyHelper::GetRadiotapHeader(), ns3::WifiPhy::NotifyMonitorSniffRx(), ns3::WifiPhy::NotifyMonitorSniffTx(), ns3::operator<<(), ns3::HtPpdu::SetHtSigHeader(), and TracePacketReception().

Here is the caller graph for this function:

◆ IsDlMu()

bool ns3::WifiTxVector::IsDlMu ( ) const

Returns: true if this TX vector is used for a downlink multi-user (OFDMA and/or MU-MIMO) transmission

Definition at line 471 of file wifi-tx-vector.cc.

References ns3::IsDlMu(), ns3::IsEht(), m_ehtPpduType, and m_preamble.

Referenced by ns3::EhtPpdu::EhtPpdu(), ns3::HePhy::CalculateTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfBarBaSequence(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::EhtPhy::GetSigBMode(), ns3::HePhy::GetSigMode(), ns3::HeFrameExchangeManager::GetTxDuration(), ns3::HePhy::IsConfigSupported(), IsMu(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::WifiDefaultAckManager::TryAddMpdu(), ns3::WifiDefaultProtectionManager::TryAddMpdu(), ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu(), and ns3::WifiDefaultProtectionManager::TryAggregateMsdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLdpc()

bool ns3::WifiTxVector::IsLdpc ( ) const

Check if LDPC FEC coding is used or not.

Returns: true if LDPC is used, false if BCC is used

Definition at line 251 of file wifi-tx-vector.cc.

References m_ldpc.

Referenced by ns3::TableBasedErrorRateModel::DoGetChunkSuccessRate(), and ns3::operator<<().

Here is the caller graph for this function:

◆ IsMu()

bool ns3::WifiTxVector::IsMu ( ) const

Returns: true if this TX vector is used for a multi-user (OFDMA and/or MU-MIMO) transmission

Definition at line 465 of file wifi-tx-vector.cc.

References IsDlMu(), and IsUlMu().

Referenced by ns3::HePpdu::HePpdu(), ns3::YansErrorRateModel::DoGetChunkSuccessRate(), ns3::HePhy::GetChannelWidthAndBand(), ns3::EhtPhy::GetDataRateFromTxVector(), ns3::HePhy::GetDataRateFromTxVector(), GetHeMuUserInfo(), GetHeMuUserInfoMap(), GetMode(), GetModulationClass(), GetNss(), GetNssMax(), ns3::EhtPhy::GetPhyRateFromTxVector(), ns3::HePhy::GetPhyRateFromTxVector(), GetRu(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), ns3::WifiRemoteStationManager::GetStaId(), ns3::HeFrameExchangeManager::GetTxDuration(), IsNonHtDuplicate(), ns3::operator<<(), SetHeMuUserInfo(), SetMode(), SetNss(), SetRu(), and OfdmaAckSequenceTest::Transmit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsNonHtDuplicate()

bool ns3::WifiTxVector::IsNonHtDuplicate ( ) const

Checks whether this TXVECTOR corresponds to a non-HT duplicate.

Returns: true if this TXVECTOR corresponds to a non-HT duplicate, false otherwise.

Definition at line 257 of file wifi-tx-vector.cc.

References GetMode(), GetModulationClass(), IsMu(), m_channelWidth, and ns3::WIFI_MOD_CLASS_HT.

Here is the call graph for this function:

◆ IsStbc()

bool ns3::WifiTxVector::IsStbc ( ) const

Check if STBC is used or not.

Returns: true if STBC is used, false otherwise

Definition at line 245 of file wifi-tx-vector.cc.

References m_stbc.

Referenced by ns3::HtPhy::GetPayloadDuration(), ns3::WifiPhyHelper::GetRadiotapHeader(), and ns3::operator<<().

Here is the caller graph for this function:

◆ IsTriggerResponding()

bool ns3::WifiTxVector::IsTriggerResponding ( ) const

Return true if the Trigger Responding parameter is set to true, false otherwise.

Returns: true if the Trigger Responding parameter is set to true, false otherwise

Definition at line 372 of file wifi-tx-vector.cc.

References m_triggerResponding.

Referenced by ns3::HePhy::ObtainNextUid().

Here is the caller graph for this function:

◆ IsUlMu()

bool ns3::WifiTxVector::IsUlMu ( ) const

Returns: true if this TX vector is used for an uplink multi-user (OFDMA and/or MU-MIMO) transmission

Definition at line 477 of file wifi-tx-vector.cc.

References ns3::IsUlMu(), and m_preamble.

Referenced by ns3::HePhy::CalculateTxDuration(), ns3::HePhy::ConvertHeTbPpduDurationToLSigLength(), ns3::HePhy::ConvertLSigLengthToHeTbPpduDuration(), ns3::HeFrameExchangeManager::EndReceiveAmpdu(), ns3::HePhy::GetCenterFrequencyForNonOfdmaPart(), ns3::HePhy::GetNonOfdmaBand(), ns3::HePhy::GetTrainingDuration(), ns3::HePpdu::GetTransmissionChannelWidth(), ns3::HeFrameExchangeManager::GetTxDuration(), IsMu(), ns3::HePhy::ObtainNextUid(), ns3::operator<<(), ns3::HeFrameExchangeManager::ReceiveMpdu(), WifiPrimaryChannelsTest::ReceiveUl(), ns3::HePhy::RxPayloadFailed(), ns3::HeFrameExchangeManager::SendPsduMapWithProtection(), ns3::HePpdu::SetHeSigHeader(), ns3::HeFrameExchangeManager::SetTxopHolder(), MultiLinkMuTxTest::Transmit(), ns3::WifiDefaultAckManager::TryAddMpdu(), ns3::WifiDefaultProtectionManager::TryAddMpdu(), and ns3::WifiDefaultProtectionManager::TryAggregateMsdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsValid()

bool ns3::WifiTxVector::IsValid ( ) const

The standard disallows certain combinations of WifiMode, number of spatial streams, and channel widths.

This method can be used to check whether this WifiTxVector contains an invalid combination.

Returns: true if the WifiTxVector parameters are allowed by the standard

Definition at line 429 of file wifi-tx-vector.cc.

References GetModeInitialized(), ns3::WifiMode::GetUniqueName(), m_channelWidth, m_mode, and m_nss.

Referenced by ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::IsValidMcs(), and ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAggregation()

void ns3::WifiTxVector::SetAggregation ( bool aggregation )

Sets if PSDU contains A-MPDU.

Parameters

aggregation whether the PSDU contains A-MPDU or not

Definition at line 330 of file wifi-tx-vector.cc.

References m_aggregation.

Referenced by ns3::HtFrameExchangeManager::ForwardPsduDown(), ns3::HeFrameExchangeManager::ForwardPsduMapDown(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), ns3::HtPpdu::SetTxVectorFromPhyHeaders(), and ns3::VhtPpdu::SetTxVectorFromPhyHeaders().

Here is the caller graph for this function:

◆ SetBssColor()

void ns3::WifiTxVector::SetBssColor ( uint8_t color )

Set the BSS color.

Parameters

color the BSS color

Definition at line 348 of file wifi-tx-vector.cc.

References m_bssColor.

Referenced by ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::HeFrameExchangeManager::GetHeTbTxVector(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the caller graph for this function:

◆ SetChannelWidth()

void ns3::WifiTxVector::SetChannelWidth ( uint16_t channelWidth )

Sets the selected channelWidth (in MHz)

Parameters

channelWidth the channel width (in MHz)

Definition at line 292 of file wifi-tx-vector.cc.

References m_channelWidth.

Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), HeSigBDurationTest::BuildTxVector(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckMuTxDuration(), TxDurationTest::CheckPayloadDuration(), TxDurationTest::CheckTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), ns3::HigherLayerTxVectorTag::Deserialize(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetRtsTxVector(), ns3::DsssPpdu::DoGetTxVector(), PhyHeaderSectionsTest::DoRun(), WifiErrorRateModelsTestCaseMimo::DoRun(), ns3::VsaManager::DoSendVsa(), TestMultipleCtsResponsesFromMuRts::FakePreviousMuRts(), ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WaveFrameExchangeManager::GetDataTxVector(), ns3::CtrlTriggerHeader::GetHeTbTxVector(), ns3::WifiMode::GetPhyRate(), ns3::WifiRemoteStationManager::GetRtsTxVector(), ns3::HeFrameExchangeManager::GetTrigVector(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), ns3::WifiMode::IsAllowed(), ns3::MinstrelHtWifiManager::IsValidMcs(), InterferenceExperiment::SendA(), InterferenceExperiment::SendB(), ns3::WaveNetDevice::SendX(), ns3::OfdmPpdu::SetTxVectorFromLSigHeader(), ns3::ErpOfdmPpdu::SetTxVectorFromLSigHeader(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), ns3::HtPpdu::SetTxVectorFromPhyHeaders(), ns3::VhtPpdu::SetTxVectorFromPhyHeaders(), NodeStatistics::SetupPhy(), ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu(), ns3::RrMultiUserScheduler::TrySendingDlMuPpdu(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

Here is the caller graph for this function:

◆ SetEhtPpduType()

void ns3::WifiTxVector::SetEhtPpduType ( uint8_t type )

Set the EHT_PPDU_TYPE parameter.

Parameters

type	the EHT_PPDU_TYPE parameter

Definition at line 416 of file wifi-tx-vector.cc.

References ns3::IsEht(), m_ehtPpduType, m_preamble, NS_ASSERT, and check-style-clang-format::type.

Referenced by TxDurationTest::CheckMuTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), PhyHeaderSectionsTest::DoRun(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetGuardInterval()

void ns3::WifiTxVector::SetGuardInterval ( uint16_t guardInterval )

Sets the guard interval duration (in nanoseconds)

Parameters

guardInterval the guard interval duration (in nanoseconds)

Definition at line 298 of file wifi-tx-vector.cc.

References m_guardInterval.

Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), HeSigBDurationTest::BuildTxVector(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckMuTxDuration(), TxDurationTest::CheckPayloadDuration(), TxDurationTest::CheckTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::CtrlTriggerHeader::GetHeTbTxVector(), ns3::WifiMode::GetPhyRate(), ns3::WifiRemoteStationManager::GetRtsTxVector(), ns3::HeFrameExchangeManager::GetTrigVector(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), TestMultiUserScheduler::SelectTxFormat(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), ns3::HtPpdu::SetTxVectorFromPhyHeaders(), ns3::VhtPpdu::SetTxVectorFromPhyHeaders(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the caller graph for this function:

◆ SetHeMuUserInfo()

void ns3::WifiTxVector::SetHeMuUserInfo	(	uint16_t	staId,
		HeMuUserInfo	userInfo
	)

Set the HE MU user-specific transmission information for the given STA-ID.

This is applicable only for HE MU.

Parameters

staId	the station ID
userInfo	the HE MU user-specific transmission information

Definition at line 506 of file wifi-tx-vector.cc.

References IsMu(), m_modeInitialized, m_muUserInfos, m_ruAllocation, and NS_ABORT_MSG_IF.

Referenced by HeSigBDurationTest::BuildTxVector(), TxDurationTest::CheckMuTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), PhyHeaderSectionsTest::DoRun(), WifiPrimaryChannelsTest::DoSendHeTbPpdu(), ns3::RrMultiUserScheduler::FinalizeTxVector(), ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::CtrlTriggerHeader::GetHeTbTxVector(), ns3::HeFrameExchangeManager::GetTrigVector(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), TestMultipleHeTbPreambles::RxHeTbPpdu(), WifiPrimaryChannelsTest::SendDlMuPpdu(), ns3::HeFrameExchangeManager::SendPsduMap(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetInactiveSubchannels()

void ns3::WifiTxVector::SetInactiveSubchannels ( const std::vector< bool > & inactiveSubchannels )

Set the 20 MHz subchannels that are punctured.

Parameters

inactiveSubchannels the bitmap indexed by the 20 MHz subchannels in ascending order, where each bit indicates whether the corresponding 20 MHz subchannel is punctured or not within the transmission bandwidth

Definition at line 579 of file wifi-tx-vector.cc.

References m_channelWidth, m_inactiveSubchannels, m_preamble, NS_ABORT_MSG_IF, and ns3::WIFI_PREAMBLE_HE_SU.

Referenced by TestDlOfdmaPhyPuncturing::SendMuPpdu().

Here is the caller graph for this function:

◆ SetLdpc()

void ns3::WifiTxVector::SetLdpc ( bool ldpc )

Sets if LDPC FEC coding is being used.

Parameters

ldpc	enable or disable LDPC

Definition at line 342 of file wifi-tx-vector.cc.

References m_ldpc.

Referenced by ns3::WifiRemoteStationManager::GetDataTxVector().

Here is the caller graph for this function:

◆ SetLength()

void ns3::WifiTxVector::SetLength ( uint16_t length )

Set the LENGTH field of the L-SIG.

Parameters

length the LENGTH field of the L-SIG

Definition at line 360 of file wifi-tx-vector.cc.

References m_length.

Referenced by WifiPrimaryChannelsTest::DoSendHeTbPpdu(), ns3::CtrlTriggerHeader::GetHeTbTxVector(), ns3::HeFrameExchangeManager::GetTrigVector(), TestMultipleHeTbPreambles::RxHeTbPpdu(), TestPhyPaddingExclusion::SendHeTbPpdu(), TestUlOfdmaPhyTransmission::SendHeTbPpdu(), ns3::HeFrameExchangeManager::SendPsduMap(), TestUlOfdmaPpduUid::SendTbPpdu(), TestPhyPaddingExclusion::SetTrigVector(), TestUlOfdmaPhyTransmission::SetTrigVector(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), and ns3::EhtPpdu::SetTxVectorFromPhyHeaders().

Here is the caller graph for this function:

◆ SetMode() [1/2]

void ns3::WifiTxVector::SetMode ( WifiMode mode )

Sets the selected payload transmission mode.

Parameters

mode	the payload WifiMode

Definition at line 264 of file wifi-tx-vector.cc.

References m_mode, and m_modeInitialized.

Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckPayloadDuration(), TxDurationTest::CheckTxDuration(), ns3::HigherLayerTxVectorTag::Deserialize(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetRtsTxVector(), PhyHeaderSectionsTest::DoRun(), WifiErrorRateModelsTestCaseMimo::DoRun(), TableBasedErrorRateTestCase::DoRun(), ns3::VsaManager::DoSendVsa(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WaveFrameExchangeManager::GetDataTxVector(), ns3::HeFrameExchangeManager::GetMuRtsDurationId(), ns3::WifiMode::GetPhyRate(), ns3::WifiRemoteStationManager::GetRtsTxVector(), TestUlOfdmaPhyTransmission::GetTxVectorForHeTbPpdu(), ns3::WifiMode::IsAllowed(), ns3::MinstrelHtWifiManager::IsValidMcs(), TestMultipleHeTbPreambles::RxHeTbPpdu(), PsrExperiment::Send(), ns3::WaveNetDevice::Send(), CollisionExperiment::SendA(), InterferenceExperiment::SendA(), CollisionExperiment::SendB(), InterferenceExperiment::SendB(), TestPhyPaddingExclusion::SendHeTbPpdu(), TestUlOfdmaPpduUid::SendMuPpdu(), TestDlOfdmaPhyTransmission::SendMuPpdu(), TestDlOfdmaPhyPuncturing::SendMuPpdu(), TestUlOfdmaPpduUid::SendTbPpdu(), ns3::WaveNetDevice::SendX(), TestPhyPaddingExclusion::SetTrigVector(), TestUlOfdmaPhyTransmission::SetTrigVector(), ns3::DsssPpdu::SetTxVectorFromDsssHeader(), ns3::OfdmPpdu::SetTxVectorFromLSigHeader(), ns3::ErpOfdmPpdu::SetTxVectorFromLSigHeader(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), ns3::HtPpdu::SetTxVectorFromPhyHeaders(), ns3::VhtPpdu::SetTxVectorFromPhyHeaders(), ns3::MinstrelWifiManager::SetupPhy(), ns3::RraaWifiManager::SetupPhy(), ns3::RrpaaWifiManager::SetupPhy(), NodeStatistics::SetupPhy(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

Here is the caller graph for this function:

◆ SetMode() [2/2]

void ns3::WifiTxVector::SetMode	(	WifiMode	mode,
		uint16_t	staId
	)

Sets the selected payload transmission mode for a given STA ID (for MU only)

Parameters

mode
staId	the station ID for MU

Definition at line 271 of file wifi-tx-vector.cc.

References ns3::WifiMode::GetMcsValue(), IsMu(), m_modeInitialized, m_muUserInfos, and NS_ABORT_MSG_IF.

Here is the call graph for this function:

◆ SetNess()

void ns3::WifiTxVector::SetNess ( uint8_t ness )

Sets the Ness number.

Parameters

ness	the number of extended spatial streams

Definition at line 324 of file wifi-tx-vector.cc.

References m_ness.

Referenced by HeSigBDurationTest::BuildTxVector(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckMuTxDuration(), TxDurationTest::CheckPayloadDuration(), TxDurationTest::CheckTxDuration(), PhyHeaderSectionsTest::DoRun(), ns3::WifiRemoteStationManager::GetDataTxVector(), and ns3::WifiRemoteStationManager::GetRtsTxVector().

Here is the caller graph for this function:

◆ SetNss() [1/2]

void ns3::WifiTxVector::SetNss ( uint8_t nss )

Sets the number of Nss.

Parameters

nss	the number of spatial streams

Definition at line 310 of file wifi-tx-vector.cc.

References m_nss.

Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckPayloadDuration(), TxDurationTest::CheckTxDuration(), ns3::IdealWifiManager::DoGetDataTxVector(), ns3::IdealWifiManager::DoGetRtsTxVector(), PhyHeaderSectionsTest::DoRun(), WifiErrorRateModelsTestCaseMimo::DoRun(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WifiMode::GetPhyRate(), ns3::WifiRemoteStationManager::GetRtsTxVector(), TestUlOfdmaPhyTransmission::GetTxVectorForHeTbPpdu(), ns3::WifiMode::IsAllowed(), ns3::MinstrelHtWifiManager::IsValidMcs(), TestMultipleHeTbPreambles::RxHeTbPpdu(), TestPhyPaddingExclusion::SendHeTbPpdu(), TestUlOfdmaPpduUid::SendMuPpdu(), TestDlOfdmaPhyTransmission::SendMuPpdu(), TestDlOfdmaPhyPuncturing::SendMuPpdu(), TestUlOfdmaPpduUid::SendTbPpdu(), TestPhyPaddingExclusion::SetTrigVector(), TestUlOfdmaPhyTransmission::SetTrigVector(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), ns3::EhtPpdu::SetTxVectorFromPhyHeaders(), ns3::HtPpdu::SetTxVectorFromPhyHeaders(), and ns3::VhtPpdu::SetTxVectorFromPhyHeaders().

Here is the caller graph for this function:

◆ SetNss() [2/2]

void ns3::WifiTxVector::SetNss	(	uint8_t	nss,
		uint16_t	staId
	)

Sets the number of Nss for MU.

Parameters

nss	the number of spatial streams
staId	the station ID for MU

Definition at line 316 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, and NS_ABORT_MSG_IF.

Here is the call graph for this function:

◆ SetNTx()

void ns3::WifiTxVector::SetNTx ( uint8_t nTx )

Sets the number of TX antennas.

Parameters

nTx	the number of TX antennas

Definition at line 304 of file wifi-tx-vector.cc.

References m_nTx.

Referenced by WifiErrorRateModelsTestCaseMimo::DoRun(), ns3::WifiRemoteStationManager::GetDataTxVector(), and ns3::WifiRemoteStationManager::GetRtsTxVector().

Here is the caller graph for this function:

◆ SetPreambleType()

void ns3::WifiTxVector::SetPreambleType ( WifiPreamble preamble )

Sets the preamble type.

Parameters

preamble the preamble type

Definition at line 286 of file wifi-tx-vector.cc.

References m_preamble.

Referenced by HeSigBDurationTest::BuildTxVector(), ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckMuTxDuration(), TxDurationTest::CheckPayloadDuration(), TxDurationTest::CheckTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), ns3::HigherLayerTxVectorTag::Deserialize(), ns3::HePpdu::DoGetTxVector(), ns3::HtPpdu::DoGetTxVector(), ns3::DsssPpdu::DoGetTxVector(), ns3::OfdmPpdu::DoGetTxVector(), ns3::VhtPpdu::DoGetTxVector(), PhyHeaderSectionsTest::DoRun(), ns3::VsaManager::DoSendVsa(), ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar(), ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WaveFrameExchangeManager::GetDataTxVector(), ns3::CtrlTriggerHeader::GetHeTbTxVector(), ns3::WifiRemoteStationManager::GetRtsTxVector(), ns3::HeFrameExchangeManager::GetTrigVector(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), TestMultiUserScheduler::SelectTxFormat(), PsrExperiment::Send(), ns3::WaveNetDevice::Send(), CollisionExperiment::SendA(), InterferenceExperiment::SendA(), CollisionExperiment::SendB(), InterferenceExperiment::SendB(), ns3::WaveNetDevice::SendX(), ns3::MinstrelWifiManager::SetupPhy(), ns3::RraaWifiManager::SetupPhy(), ns3::RrpaaWifiManager::SetupPhy(), NodeStatistics::SetupPhy(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the caller graph for this function:

◆ SetRu()

void ns3::WifiTxVector::SetRu	(	HeRu::RuSpec	ru,
		uint16_t	staId
	)

Set the RU specification for the STA-ID.

This is applicable only for MU.

Parameters

ru	the RU specification
staId	the station ID

Definition at line 491 of file wifi-tx-vector.cc.

References IsMu(), m_muUserInfos, and NS_ABORT_MSG_IF.

Referenced by TestUlOfdmaPhyTransmission::GetTxVectorForHeTbPpdu(), TestMultipleHeTbPreambles::RxHeTbPpdu(), TestPhyPaddingExclusion::SendHeTbPpdu(), TestUlOfdmaPpduUid::SendMuPpdu(), TestDlOfdmaPhyTransmission::SendMuPpdu(), TestDlOfdmaPhyPuncturing::SendMuPpdu(), TestUlOfdmaPpduUid::SendTbPpdu(), TestPhyPaddingExclusion::SetTrigVector(), and TestUlOfdmaPhyTransmission::SetTrigVector().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRuAllocation()

void ns3::WifiTxVector::SetRuAllocation ( const RuAllocation & ruAlloc )

Set RU Allocation of SIG-B common field.

Parameters

ruAlloc 8 bit RU_ALLOCATION per 20 MHz

Definition at line 396 of file wifi-tx-vector.cc.

References DeriveRuAllocation(), ns3::IsDlMu(), m_muUserInfos, m_preamble, m_ruAllocation, and NS_ASSERT.

Referenced by TxDurationTest::CheckMuTxDuration(), TestMultiUserScheduler::ComputeWifiTxVector(), HeSigBDurationTest::DoRun(), PhyHeaderSectionsTest::DoRun(), WifiPrimaryChannelsTest::SendDlMuPpdu(), TestUlOfdmaPpduUid::SendMuPpdu(), TestDlOfdmaPhyTransmission::SendMuPpdu(), TestDlOfdmaPhyPuncturing::SendMuPpdu(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), and ns3::EhtPpdu::SetTxVectorFromPhyHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSigBMode()

void ns3::WifiTxVector::SetSigBMode ( const WifiMode & mode )

Set the MCS used for SIG-B.

Parameters

mode	MCS used for SIG-B

Definition at line 384 of file wifi-tx-vector.cc.

References m_sigBMcs.

Referenced by TxDurationTest::CheckMuTxDuration(), HeSigBDurationTest::DoRun(), PhyHeaderSectionsTest::DoRun(), ns3::EhtFrameExchangeManager::ForwardPsduDown(), ns3::HeFrameExchangeManager::ForwardPsduMapDown(), WifiPrimaryChannelsTest::SendDlMuPpdu(), TestUlOfdmaPpduUid::SendMuPpdu(), TestDlOfdmaPhyTransmission::SendMuPpdu(), TestDlOfdmaPhyPuncturing::SendMuPpdu(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), and ns3::EhtPpdu::SetTxVectorFromPhyHeaders().

Here is the caller graph for this function:

◆ SetStbc()

void ns3::WifiTxVector::SetStbc ( bool stbc )

Sets if STBC is being used.

Parameters

stbc	enable or disable STBC

Definition at line 336 of file wifi-tx-vector.cc.

References m_stbc.

Referenced by HeSigBDurationTest::BuildTxVector(), ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), TxDurationTest::CheckMuTxDuration(), TxDurationTest::CheckPayloadDuration(), and TxDurationTest::CheckTxDuration().

Here is the caller graph for this function:

◆ SetTriggerResponding()

void ns3::WifiTxVector::SetTriggerResponding ( bool triggerResponding )

Set the Trigger Responding parameter to the given value.

Parameters

triggerResponding the value for the Trigger Responding parameter

Definition at line 378 of file wifi-tx-vector.cc.

References m_triggerResponding.

Referenced by ns3::HeFrameExchangeManager::SendCtsAfterMuRts(), and TestMultipleCtsResponsesFromMuRts::TxNonHtDuplicateCts().

Here is the caller graph for this function:

◆ SetTxPowerLevel()

void ns3::WifiTxVector::SetTxPowerLevel ( uint8_t powerlevel )

Sets the selected transmission power level.

Parameters

powerlevel the transmission power level

Definition at line 280 of file wifi-tx-vector.cc.

References m_txPowerLevel.

Referenced by TestMultiUserScheduler::ComputeWifiTxVector(), WifiErrorRateModelsTestCaseMimo::DoRun(), ns3::VsaManager::DoSendVsa(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WaveFrameExchangeManager::GetDataTxVector(), ns3::HeFrameExchangeManager::GetHeTbTxVector(), ns3::WifiRemoteStationManager::GetRtsTxVector(), PsrExperiment::Send(), ns3::WaveNetDevice::Send(), CollisionExperiment::SendA(), InterferenceExperiment::SendA(), CollisionExperiment::SendB(), InterferenceExperiment::SendB(), and ns3::WaveNetDevice::SendX().

Here is the caller graph for this function:

Member Data Documentation

◆ m_aggregation

bool ns3::WifiTxVector::m_aggregation

private

Flag whether the PSDU contains A-MPDU.

Definition at line 501 of file wifi-tx-vector.h.

Referenced by IsAggregation(), and SetAggregation().

◆ m_bssColor

uint8_t ns3::WifiTxVector::m_bssColor

private

BSS color.

Definition at line 504 of file wifi-tx-vector.h.

Referenced by GetBssColor(), and SetBssColor().

◆ m_channelWidth

uint16_t ns3::WifiTxVector::m_channelWidth

private

channel width in MHz

Definition at line 496 of file wifi-tx-vector.h.

Referenced by DeriveRuAllocation(), GetChannelWidth(), GetContentChannelAllocation(), GetNumRusPerHeSigBContentChannel(), IsNonHtDuplicate(), IsValid(), SetChannelWidth(), and SetInactiveSubchannels().

◆ m_ehtPpduType

uint8_t ns3::WifiTxVector::m_ehtPpduType

private

EHT_PPDU_TYPE per Table 36-1 IEEE 802.11be D2.3.

Definition at line 522 of file wifi-tx-vector.h.

Referenced by GetEhtPpduType(), GetNumRusPerHeSigBContentChannel(), IsDlMu(), and SetEhtPpduType().

◆ m_guardInterval

uint16_t ns3::WifiTxVector::m_guardInterval

private

guard interval duration in nanoseconds

Definition at line 497 of file wifi-tx-vector.h.

Referenced by GetGuardInterval(), and SetGuardInterval().

◆ m_inactiveSubchannels

std::vector<bool> ns3::WifiTxVector::m_inactiveSubchannels

private

Bitmap of inactive subchannels used for preamble puncturing.

Definition at line 516 of file wifi-tx-vector.h.

Referenced by GetInactiveSubchannels(), and SetInactiveSubchannels().

◆ m_ldpc

bool ns3::WifiTxVector::m_ldpc

private

LDPC FEC coding if true, BCC otherwise.

Definition at line 503 of file wifi-tx-vector.h.

Referenced by IsLdpc(), and SetLdpc().

◆ m_length

uint16_t ns3::WifiTxVector::m_length

private

LENGTH field of the L-SIG.

Definition at line 505 of file wifi-tx-vector.h.

Referenced by GetLength(), and SetLength().

◆ m_mode

WifiMode ns3::WifiTxVector::m_mode

private

The DATARATE parameter in Table 15-4.

It is the value that will be passed to PMD_RATE.request

Definition at line 489 of file wifi-tx-vector.h.

Referenced by GetMode(), GetModulationClass(), IsValid(), and SetMode().

◆ m_modeInitialized

bool ns3::WifiTxVector::m_modeInitialized

private

Internal initialization flag.

Definition at line 508 of file wifi-tx-vector.h.

Referenced by GetMode(), GetModeInitialized(), GetModulationClass(), SetHeMuUserInfo(), and SetMode().

◆ m_muUserInfos

HeMuUserInfoMap ns3::WifiTxVector::m_muUserInfos

private

HE MU specific per-user information indexed by station ID (STA-ID) corresponding to the 11 LSBs of the AID of the recipient STA This list shall be used only for HE MU.

Definition at line 511 of file wifi-tx-vector.h.

Referenced by WifiTxVector(), ~WifiTxVector(), DeriveRuAllocation(), GetContentChannelAllocation(), GetHeMuUserInfo(), GetHeMuUserInfoMap(), GetMode(), GetModulationClass(), GetNss(), GetNssMax(), GetRu(), SetHeMuUserInfo(), SetMode(), SetNss(), SetRu(), and SetRuAllocation().

◆ m_ness

uint8_t ns3::WifiTxVector::m_ness

private

number of spatial streams in beamforming

Definition at line 500 of file wifi-tx-vector.h.

Referenced by GetNess(), and SetNess().

◆ m_nss

uint8_t ns3::WifiTxVector::m_nss

private

number of spatial streams

Definition at line 499 of file wifi-tx-vector.h.

Referenced by GetNss(), GetNssMax(), IsValid(), and SetNss().

◆ m_nTx

uint8_t ns3::WifiTxVector::m_nTx

private

number of TX antennas

Definition at line 498 of file wifi-tx-vector.h.

Referenced by GetNTx(), and SetNTx().

◆ m_preamble

WifiPreamble ns3::WifiTxVector::m_preamble

private

preamble

Definition at line 495 of file wifi-tx-vector.h.

Referenced by GetMode(), GetModulationClass(), GetNumRusPerHeSigBContentChannel(), GetPreambleType(), GetRuAllocation(), IsDlMu(), IsUlMu(), SetEhtPpduType(), SetInactiveSubchannels(), SetPreambleType(), and SetRuAllocation().

◆ m_ruAllocation

RuAllocation ns3::WifiTxVector::m_ruAllocation

mutableprivate

RU allocations that are going to be carried in SIG-B common field per Table 27-1 IEEE.

Definition at line 520 of file wifi-tx-vector.h.

Referenced by GetHeMuUserInfoMap(), GetRuAllocation(), SetHeMuUserInfo(), and SetRuAllocation().

◆ m_sigBMcs

WifiMode ns3::WifiTxVector::m_sigBMcs

private

MCS_SIG_B per Table 27-1 IEEE 802.11ax-2021.

Definition at line 518 of file wifi-tx-vector.h.

Referenced by GetSigBMode(), and SetSigBMode().

◆ m_stbc

bool ns3::WifiTxVector::m_stbc

private

STBC used or not.

Definition at line 502 of file wifi-tx-vector.h.

Referenced by IsStbc(), and SetStbc().

◆ m_triggerResponding

bool ns3::WifiTxVector::m_triggerResponding

private

The Trigger Responding parameter.

Definition at line 506 of file wifi-tx-vector.h.

Referenced by IsTriggerResponding(), and SetTriggerResponding().

◆ m_txPowerLevel

uint8_t ns3::WifiTxVector::m_txPowerLevel

private

The TXPWR_LEVEL parameter in Table 15-4.

It is the value that will be passed to PMD_TXPWRLVL.request

Definition at line 492 of file wifi-tx-vector.h.

Referenced by GetTxPowerLevel(), and SetTxPowerLevel().

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

src/wifi/model/wifi-tx-vector.h
src/wifi/model/wifi-tx-vector.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HeMuUserInfoMap

Constructor & Destructor Documentation

◆ WifiTxVector() [1/3]

◆ ~WifiTxVector()

◆ WifiTxVector() [2/3]

◆ WifiTxVector() [3/3]

Member Function Documentation

◆ DeriveRuAllocation()

◆ GetBssColor()

◆ GetChannelWidth()

◆ GetContentChannelAllocation()

◆ GetEhtPpduType()

◆ GetGuardInterval()

◆ GetHeMuUserInfo()

◆ GetHeMuUserInfoMap() [1/2]

◆ GetHeMuUserInfoMap() [2/2]

◆ GetInactiveSubchannels()

◆ GetLength()

◆ GetMode()

◆ GetModeInitialized()

◆ GetModulationClass()

◆ GetNess()

◆ GetNss()

◆ GetNssMax()

◆ GetNTx()

◆ GetNumRusPerHeSigBContentChannel()

◆ GetPreambleType()

◆ GetRu()

◆ GetRuAllocation()

◆ GetSigBMode()

◆ GetTxPowerLevel()

◆ IsAggregation()

◆ IsDlMu()

◆ IsLdpc()

◆ IsMu()

◆ IsNonHtDuplicate()

◆ IsStbc()

◆ IsTriggerResponding()

◆ IsUlMu()

◆ IsValid()

◆ SetAggregation()

◆ SetBssColor()

◆ SetChannelWidth()

◆ SetEhtPpduType()

◆ SetGuardInterval()

◆ SetHeMuUserInfo()

◆ SetInactiveSubchannels()

◆ SetLdpc()

◆ SetLength()

◆ SetMode() [1/2]

◆ SetMode() [2/2]

◆ SetNess()

◆ SetNss() [1/2]

◆ SetNss() [2/2]

◆ SetNTx()

◆ SetPreambleType()

◆ SetRu()

◆ SetRuAllocation()

◆ SetSigBMode()

◆ SetStbc()

◆ SetTriggerResponding()

◆ SetTxPowerLevel()

Member Data Documentation

◆ m_aggregation

◆ m_bssColor

◆ m_channelWidth

◆ m_ehtPpduType

◆ m_guardInterval

◆ m_inactiveSubchannels

◆ m_ldpc

◆ m_length

◆ m_mode

◆ m_modeInitialized

◆ m_muUserInfos