HE PPDU (11ax) More...

#include "he-ppdu.h"

Inheritance diagram for ns3::HePpdu:

Collaboration diagram for ns3::HePpdu:

Classes
class	HeSigHeader
	HE-SIG PHY header (HE-SIG-A1/A2/B) More...

Public Types
enum	TxPsdFlag { PSD_NON_HE_TB = 0 , PSD_HE_TB_NON_OFDMA_PORTION , PSD_HE_TB_OFDMA_PORTION }
	The transmit power spectral density flag, namely used to correctly build PSD for HE TB PPDU non-OFDMA and OFDMA portions. More...

Public Member Functions
	HePpdu (const WifiConstPsduMap &psdus, const WifiTxVector &txVector, Time ppduDuration, WifiPhyBand band, uint64_t uid, TxPsdFlag flag, uint8_t p20Index)
	Create an MU HE PPDU, storing a map of PSDUs. More...

	HePpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, Time ppduDuration, WifiPhyBand band, uint64_t uid)
	Create an SU HE PPDU, storing a PSDU. More...

virtual	~HePpdu ()
	Destructor for HePpdu. More...

bool	CanBeReceived (uint16_t txCenterFreq, uint16_t p20MinFreq, uint16_t p20MaxFreq) const override
	Check whether the given PPDU can be received on the specified primary channel. More...

Ptr< WifiPpdu >	Copy (void) const override
	Copy this instance. More...

Ptr< const WifiPsdu >	GetPsdu (uint8_t bssColor, uint16_t staId=SU_STA_ID) const
	Get the payload of the PPDU. More...

uint16_t	GetStaId (void) const override
	Get the ID of the STA that transmitted the PPDU for UL MU, SU_STA_ID otherwise. More...

uint16_t	GetTransmissionChannelWidth (void) const override
	Get the channel width over which the PPDU will effectively be transmitted. More...

Time	GetTxDuration (void) const override
	Get the total transmission duration of the PPDU. More...

TxPsdFlag	GetTxPsdFlag (void) const

WifiPpduType	GetType (void) const override
	Return the PPDU type (. More...

void	SetTxPsdFlag (TxPsdFlag flag)

Public Member Functions inherited from ns3::OfdmPpdu
	OfdmPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, WifiPhyBand band, uint64_t uid, bool instantiateLSig=true)
	Create an OFDM PPDU. More...

virtual	~OfdmPpdu ()
	Destructor for OfdmPpdu. More...

Ptr< WifiPpdu >	Copy (void) const override
	Copy this instance. More...

Time	GetTxDuration (void) const override
	Get the total transmission duration of the PPDU. More...

Public Member Functions inherited from ns3::WifiPpdu
	WifiPpdu (const WifiConstPsduMap &psdus, const WifiTxVector &txVector, uint64_t uid)
	Create a PPDU storing a map of PSDUs. More...

	WifiPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, uint64_t uid=UINT64_MAX)
	Create a PPDU storing a PSDU. More...

virtual	~WifiPpdu ()
	Destructor for WifiPpdu. More...

WifiModulationClass	GetModulation (void) const
	Get the modulation used for the PPDU. More...

WifiPreamble	GetPreamble (void) const
	Get the preamble of the PPDU. More...

Ptr< const WifiPsdu >	GetPsdu (void) const
	Get the payload of the PPDU. More...

WifiTxVector	GetTxVector (void) const
	Get the TXVECTOR used to send the PPDU. More...

uint64_t	GetUid (void) const
	Get the UID of the PPDU. More...

bool	IsTruncatedTx (void) const

void	Print (std::ostream &os) const
	Print the PPDU contents. More...

void	SetTruncatedTx (void)
	Indicate that the PPDU's transmission was aborted due to transmitter switch off. More...

Public Member Functions inherited from ns3::SimpleRefCount< WifiPpdu >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Protected Member Functions
bool	IsDlMu (void) const
	Return true if the PPDU is a DL MU PPDU. More...

bool	IsMu (void) const
	Return true if the PPDU is a MU PPDU. More...

bool	IsUlMu (void) const
	Return true if the PPDU is an UL MU PPDU. More...

std::string	PrintPayload (void) const override
	Print the payload of the PPDU. More...

Protected Attributes
WifiTxVector::HeMuUserInfoMap	m_muUserInfos
	the HE MU specific per-user information (to be removed once HE-SIG-B headers are implemented) More...

Protected Attributes inherited from ns3::OfdmPpdu
WifiPhyBand	m_band
	the WifiPhyBand used to transmit that PPDU More...

uint16_t	m_channelWidth
	the channel width used to transmit that PPDU in MHz More...

LSigHeader	m_lSig
	the L-SIG PHY header More...

Protected Attributes inherited from ns3::WifiPpdu
WifiModulationClass	m_modulation
	the modulation used for the transmission of this PPDU More...

WifiPreamble	m_preamble
	the PHY preamble More...

WifiConstPsduMap	m_psdus
	the PSDUs contained in this PPDU More...

uint64_t	m_uid
	the unique ID of this PPDU More...

Private Member Functions
WifiTxVector	DoGetTxVector (void) const override
	Get the TXVECTOR used to send the PPDU. More...

void	SetPhyHeaders (const WifiTxVector &txVector, Time ppduDuration)
	Fill in the HE PHY headers. More...

Private Attributes
HeSigHeader	m_heSig
	the HE-SIG PHY header More...

TxPsdFlag	m_txPsdFlag
	the transmit power spectral density flag More...

Detailed Description

HE PPDU (11ax)

HePpdu stores a preamble, PHY headers and a map of PSDUs of a PPDU with HE header

Definition at line 44 of file he-ppdu.h.

Member Enumeration Documentation

◆ TxPsdFlag

enum ns3::HePpdu::TxPsdFlag

The transmit power spectral density flag, namely used to correctly build PSD for HE TB PPDU non-OFDMA and OFDMA portions.

Enumerator
PSD_NON_HE_TB	non-HE TB PPDU transmissions
PSD_HE_TB_NON_OFDMA_PORTION	preamble of HE TB PPDU, which should only be sent on minimum subset of 20 MHz channels containing RU
PSD_HE_TB_OFDMA_PORTION	OFDMA portion of HE TB PPDU, which should only be sent on RU.

Definition at line 158 of file he-ppdu.h.

Constructor & Destructor Documentation

◆ HePpdu() [1/2]

ns3::HePpdu::HePpdu	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector,
		Time	ppduDuration,
		WifiPhyBand	band,
		uint64_t	uid
	)

Create an SU HE PPDU, storing a PSDU.

Parameters

psdu	the PHY payload (PSDU)
txVector	the TXVECTOR that was used for this PPDU
ppduDuration	the transmission duration of this PPDU
band	the WifiPhyBand used for the transmission of this PPDU
uid	the unique ID of this PPDU

Definition at line 75 of file he-ppdu.cc.

References IsMu(), NS_ASSERT, NS_LOG_FUNCTION, PSD_NON_HE_TB, SetPhyHeaders(), and SetTxPsdFlag().

Here is the call graph for this function:

◆ HePpdu() [2/2]

ns3::HePpdu::HePpdu	(	const WifiConstPsduMap &	psdus,
		const WifiTxVector &	txVector,
		Time	ppduDuration,
		WifiPhyBand	band,
		uint64_t	uid,
		TxPsdFlag	flag,
		uint8_t	p20Index
	)

Create an MU HE PPDU, storing a map of PSDUs.

This PPDU can either be UL or DL.

Parameters

psdus	the PHY payloads (PSDUs)
txVector	the TXVECTOR that was used for this PPDU
ppduDuration	the transmission duration of this PPDU
band	the WifiPhyBand used for the transmission of this PPDU
uid	the unique ID of this PPDU or of the triggering PPDU if this is an HE TB PPDU
flag	the flag indicating the type of Tx PSD to build
p20Index	the index of the primary 20 MHz channel

Definition at line 50 of file he-ppdu.cc.

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetHeMuUserInfoMap(), IsMu(), m_muUserInfos, ns3::WifiPpdu::m_psdus, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, SetPhyHeaders(), and SetTxPsdFlag().

Here is the call graph for this function:

◆ ~HePpdu()

ns3::HePpdu::~HePpdu ( )

virtual

Destructor for HePpdu.

Definition at line 85 of file he-ppdu.cc.

Member Function Documentation

◆ CanBeReceived()

bool ns3::HePpdu::CanBeReceived	(	uint16_t	txCenterFreq,
		uint16_t	p20MinFreq,
		uint16_t	p20MaxFreq
	)		const

overridevirtual

Check whether the given PPDU can be received on the specified primary channel.

Normally, a PPDU can be received if it is transmitted over a channel that overlaps the primary20 channel of a PHY entity.

Parameters

txCenterFreq	the center frequency (MHz) of the channel over which the PPDU is transmitted
p20MinFreq	the minimum frequency (MHz) of the primary channel
p20MaxFreq	the maximum frequency (MHz) of the primary channel

Returns: true if this PPDU can be received, false otherwise

Reimplemented from ns3::WifiPpdu.

Definition at line 262 of file he-ppdu.cc.

References ns3::WifiPpdu::CanBeReceived(), IsUlMu(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Copy()

Ptr< WifiPpdu > ns3::HePpdu::Copy ( void ) const

overridevirtual

Copy this instance.

Returns: a Ptr to a copy of this instance.

Reimplemented from ns3::WifiPpdu.

Definition at line 167 of file he-ppdu.cc.

References ns3::Copy().

Here is the call graph for this function:

◆ DoGetTxVector()

WifiTxVector ns3::HePpdu::DoGetTxVector ( void ) const

overrideprivatevirtual

Get the TXVECTOR used to send the PPDU.

Returns: the TXVECTOR of the PPDU.

Reimplemented from ns3::WifiPpdu.

Definition at line 128 of file he-ppdu.cc.

References ns3::HePpdu::HeSigHeader::GetBssColor(), ns3::HePpdu::HeSigHeader::GetChannelWidth(), ns3::HePpdu::HeSigHeader::GetGuardInterval(), ns3::HePhy::GetHeMcs(), ns3::OfdmPpdu::LSigHeader::GetLength(), ns3::HePpdu::HeSigHeader::GetMcs(), ns3::HePpdu::HeSigHeader::GetNStreams(), m_heSig, ns3::OfdmPpdu::m_lSig, m_muUserInfos, ns3::WifiPpdu::m_preamble, ns3::WifiPpdu::m_psdus, ns3::WifiTxVector::SetAggregation(), ns3::WifiTxVector::SetBssColor(), ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetHeMuUserInfo(), ns3::WifiTxVector::SetLength(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), and ns3::WifiTxVector::SetPreambleType().

Here is the call graph for this function:

◆ GetPsdu()

Ptr< const WifiPsdu > ns3::HePpdu::GetPsdu	(	uint8_t	bssColor,
		uint16_t	staId = `SU_STA_ID`
	)		const

Get the payload of the PPDU.

Parameters

bssColor	the BSS color of the PHY calling this function.
staId	the STA-ID of the PHY calling this function.

Returns: the PSDU

Definition at line 205 of file he-ppdu.cc.

References ns3::HePpdu::HeSigHeader::GetBssColor(), IsMu(), IsUlMu(), m_heSig, ns3::WifiPpdu::m_psdus, NS_ASSERT, and SU_STA_ID.

Here is the call graph for this function:

◆ GetStaId()

uint16_t ns3::HePpdu::GetStaId ( void ) const

overridevirtual

Get the ID of the STA that transmitted the PPDU for UL MU, SU_STA_ID otherwise.

Returns: the ID of the STA that transmitted the PPDU for UL MU, SU_STA_ID otherwise

Reimplemented from ns3::WifiPpdu.

Definition at line 235 of file he-ppdu.cc.

References IsUlMu(), ns3::WifiPpdu::m_psdus, and NS_ASSERT.

Referenced by GetTransmissionChannelWidth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTransmissionChannelWidth()

uint16_t ns3::HePpdu::GetTransmissionChannelWidth ( void ) const

overridevirtual

Get the channel width over which the PPDU will effectively be transmitted.

Returns: the effective channel width (in MHz) used for the tranmsission

Reimplemented from ns3::WifiPpdu.

Definition at line 242 of file he-ppdu.cc.

References ns3::HeRu::GetBandwidth(), ns3::WifiTxVector::GetPreambleType(), ns3::WifiTxVector::GetRu(), GetStaId(), ns3::WifiPpdu::GetTransmissionChannelWidth(), GetTxPsdFlag(), ns3::WifiPpdu::GetTxVector(), NS_ASSERT, NS_LOG_INFO, PSD_HE_TB_NON_OFDMA_PORTION, PSD_NON_HE_TB, SU_STA_ID, and ns3::WIFI_PREAMBLE_HE_TB.

Here is the call graph for this function:

◆ GetTxDuration()

Time ns3::HePpdu::GetTxDuration ( void ) const

overridevirtual

Get the total transmission duration of the PPDU.

Returns: the transmission duration of the PPDU

Reimplemented from ns3::WifiPpdu.

Definition at line 147 of file he-ppdu.cc.

References ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::WifiTxVector::GetGuardInterval(), ns3::OfdmPpdu::LSigHeader::GetLength(), ns3::Time::GetNanoSeconds(), ns3::WifiPpdu::GetTxVector(), IsDlMu(), ns3::OfdmPpdu::m_band, ns3::OfdmPpdu::m_lSig, ns3::MicroSeconds(), ns3::NanoSeconds(), ns3::Seconds(), and ns3::WIFI_PHY_BAND_2_4GHZ.

Here is the call graph for this function:

◆ GetTxPsdFlag()

HePpdu::TxPsdFlag ns3::HePpdu::GetTxPsdFlag ( void ) const

Returns: the transmit PSD flag set for this PPDU

See also: TxPsdFlag

Definition at line 275 of file he-ppdu.cc.

References m_txPsdFlag.

Referenced by GetTransmissionChannelWidth().

Here is the caller graph for this function:

◆ GetType()

WifiPpduType ns3::HePpdu::GetType ( void ) const

overridevirtual

Return the PPDU type (.

See also: WifiPpduType)

Returns: the PPDU type

Reimplemented from ns3::WifiPpdu.

Definition at line 173 of file he-ppdu.cc.

References ns3::WifiPpdu::m_preamble, ns3::WIFI_PPDU_TYPE_DL_MU, ns3::WIFI_PPDU_TYPE_SU, ns3::WIFI_PPDU_TYPE_UL_MU, ns3::WIFI_PREAMBLE_HE_MU, and ns3::WIFI_PREAMBLE_HE_TB.

◆ IsDlMu()

bool ns3::HePpdu::IsDlMu ( void ) const

protected

Return true if the PPDU is a DL MU PPDU.

Returns: true if the PPDU is a DL MU PPDU

Definition at line 193 of file he-ppdu.cc.

References ns3::WifiPpdu::m_preamble, and ns3::WIFI_PREAMBLE_HE_MU.

Referenced by GetTxDuration(), IsMu(), and SetPhyHeaders().

Here is the caller graph for this function:

◆ IsMu()

bool ns3::HePpdu::IsMu ( void ) const

protected

Return true if the PPDU is a MU PPDU.

Returns: true if the PPDU is a MU PPDU

Definition at line 187 of file he-ppdu.cc.

References IsDlMu(), and IsUlMu().

Referenced by HePpdu(), GetPsdu(), and PrintPayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsUlMu()

bool ns3::HePpdu::IsUlMu ( void ) const

protected

Return true if the PPDU is an UL MU PPDU.

Returns: true if the PPDU is an UL MU PPDU

Definition at line 199 of file he-ppdu.cc.

References ns3::WifiPpdu::m_preamble, and ns3::WIFI_PREAMBLE_HE_TB.

Referenced by CanBeReceived(), GetPsdu(), GetStaId(), IsMu(), SetPhyHeaders(), and SetTxPsdFlag().

Here is the caller graph for this function:

◆ PrintPayload()

std::string ns3::HePpdu::PrintPayload ( void ) const

overrideprotectedvirtual

Print the payload of the PPDU.

Returns: information on the payload part of the PPDU

Reimplemented from ns3::WifiPpdu.

Definition at line 289 of file he-ppdu.cc.

References IsMu(), ns3::WifiPpdu::m_psdus, m_txPsdFlag, and SU_STA_ID.

Here is the call graph for this function:

◆ SetPhyHeaders()

void ns3::HePpdu::SetPhyHeaders	(	const WifiTxVector &	txVector,
		Time	ppduDuration
	)

private

Fill in the HE PHY headers.

Parameters

txVector	the TXVECTOR that was used for this PPDU
ppduDuration	the transmission duration of this PPDU

Definition at line 90 of file he-ppdu.cc.

References ns3::WifiTxVector::GetBssColor(), ns3::WifiTxVector::GetGuardInterval(), ns3::WifiMode::GetMcsValue(), ns3::WifiTxVector::GetMode(), ns3::Time::GetNanoSeconds(), ns3::WifiTxVector::GetNss(), IsDlMu(), IsUlMu(), ns3::OfdmPpdu::m_band, ns3::OfdmPpdu::m_channelWidth, m_heSig, ns3::OfdmPpdu::m_lSig, ns3::WifiPpdu::m_preamble, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::HePpdu::HeSigHeader::SetBssColor(), ns3::HePpdu::HeSigHeader::SetChannelWidth(), ns3::HePpdu::HeSigHeader::SetGuardIntervalAndLtfSize(), ns3::OfdmPpdu::LSigHeader::SetLength(), ns3::HePpdu::HeSigHeader::SetMcs(), ns3::HePpdu::HeSigHeader::SetMuFlag(), ns3::HePpdu::HeSigHeader::SetNStreams(), ns3::WIFI_PHY_BAND_2_4GHZ, ns3::WIFI_PREAMBLE_HE_MU, ns3::WIFI_PREAMBLE_HE_SU, and ns3::WIFI_PREAMBLE_HE_TB.

Referenced by HePpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTxPsdFlag()

void ns3::HePpdu::SetTxPsdFlag ( TxPsdFlag flag )

Parameters

flag	the transmit PSD flag set for this PPDU

See also: TxPsdFlag

Definition at line 281 of file he-ppdu.cc.

References IsUlMu(), m_txPsdFlag, NS_ASSERT, NS_LOG_FUNCTION, and PSD_NON_HE_TB.

Referenced by HePpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_heSig

HeSigHeader ns3::HePpdu::m_heSig

private

the HE-SIG PHY header

Definition at line 259 of file he-ppdu.h.

Referenced by DoGetTxVector(), GetPsdu(), and SetPhyHeaders().

◆ m_muUserInfos

WifiTxVector::HeMuUserInfoMap ns3::HePpdu::m_muUserInfos

protected

the HE MU specific per-user information (to be removed once HE-SIG-B headers are implemented)

Definition at line 246 of file he-ppdu.h.

Referenced by HePpdu(), and DoGetTxVector().

◆ m_txPsdFlag

TxPsdFlag ns3::HePpdu::m_txPsdFlag

private

the transmit power spectral density flag

Definition at line 260 of file he-ppdu.h.

Referenced by GetTxPsdFlag(), PrintPayload(), and SetTxPsdFlag().

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

src/wifi/model/he/he-ppdu.h
src/wifi/model/he/he-ppdu.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ TxPsdFlag

Constructor & Destructor Documentation

◆ HePpdu() [1/2]

◆ HePpdu() [2/2]

◆ ~HePpdu()

Member Function Documentation

◆ CanBeReceived()

◆ Copy()

◆ DoGetTxVector()

◆ GetPsdu()

◆ GetStaId()

◆ GetTransmissionChannelWidth()

◆ GetTxDuration()

◆ GetTxPsdFlag()

◆ GetType()

◆ IsDlMu()

◆ IsMu()

◆ IsUlMu()

◆ PrintPayload()

◆ SetPhyHeaders()

◆ SetTxPsdFlag()

Member Data Documentation

◆ m_heSig

◆ m_muUserInfos

◆ m_txPsdFlag