HT PPDU (11n) More...

#include "ht-ppdu.h"

Inheritance diagram for ns3::HtPpdu:

Collaboration diagram for ns3::HtPpdu:

Classes
class	HtSigHeader
	HT PHY header (HT-SIG1/2). More...

Public Member Functions
	HtPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, const WifiPhyOperatingChannel &channel, Time ppduDuration, uint64_t uid)
	Create an HT PPDU.

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

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

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

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

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

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

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

virtual	~WifiPpdu ()
	Destructor for WifiPpdu.

bool	DoesOverlapChannel (MHz_u minFreq, MHz_u maxFreq) const
	Check whether the given PPDU overlaps a given channel.

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

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

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

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

std::vector< MHz_u >	GetTxCenterFreqs () const

virtual MHz_u	GetTxChannelWidth () const
	Get the channel width over which the PPDU will effectively be transmitted.

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

virtual WifiPpduType	GetType () const
	Return the PPDU type (.

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

bool	IsTruncatedTx () const

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

void	ResetTxVector () const
	Reset the TXVECTOR.

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

void	UpdateTxVector (const WifiTxVector &updatedTxVector) const
	Update the TXVECTOR based on some information known at the receiver.

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

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

void	SetHtSigHeader (HtSigHeader &htSig, const WifiTxVector &txVector, std::size_t psduSize) const
	Fill in the HT-SIG header.

virtual void	SetLSigHeader (LSigHeader &lSig, Time ppduDuration) const
	Fill in the L-SIG header.

void	SetPhyHeaders (const WifiTxVector &txVector, Time ppduDuration, std::size_t psduSize)
	Fill in the PHY headers.

void	SetTxVectorFromPhyHeaders (WifiTxVector &txVector, const LSigHeader &lSig, const HtSigHeader &htSig) const
	Fill in the TXVECTOR from PHY headers.

Private Attributes
HtSigHeader	m_htSig
	the HT-SIG PHY header

Additional Inherited Members
Protected Member Functions inherited from ns3::WifiPpdu
virtual std::string	PrintPayload () const
	Print the payload of the PPDU.

Protected Attributes inherited from ns3::OfdmPpdu
LSigHeader	m_lSig
	the L-SIG PHY header

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

const WifiPhyOperatingChannel &	m_operatingChannel
	the operating channel of the PHY

WifiPreamble	m_preamble
	the PHY preamble

WifiConstPsduMap	m_psdus
	the PSDUs contained in this PPDU

std::vector< MHz_u >	m_txCenterFreqs
	the center frequency per segment used for the transmission of this PPDU

std::optional< WifiTxVector >	m_txVector
	the TXVECTOR at TX PHY or the reconstructed TXVECTOR at RX PHY (or std::nullopt if TXVECTOR has not been reconstructed yet)

uint64_t	m_uid
	the unique ID of this PPDU

Detailed Description

HT PPDU (11n)

HtPpdu stores a preamble, PHY headers and a PSDU of a PPDU with HT header

Definition at line 33 of file ht-ppdu.h.

Constructor & Destructor Documentation

◆ HtPpdu()

ns3::HtPpdu::HtPpdu	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector,
		const WifiPhyOperatingChannel &	channel,
		Time	ppduDuration,
		uint64_t	uid )

Create an HT PPDU.

Parameters

psdu	the PHY payload (PSDU)
txVector	the TXVECTOR that was used for this PPDU
channel	the operating channel of the PHY used to transmit this PPDU
ppduDuration	the transmission duration of this PPDU
uid	the unique ID of this PPDU

Definition at line 26 of file ht-ppdu.cc.

References NS_LOG_FUNCTION, and SetPhyHeaders().

Referenced by Copy().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ Copy()

Ptr< WifiPpdu > ns3::HtPpdu::Copy ( ) const

overridevirtual

Copy this instance.

Returns: a Ptr to a copy of this instance.

Reimplemented from ns3::WifiPpdu.

Definition at line 108 of file ht-ppdu.cc.

References HtPpdu().

Here is the call graph for this function:

◆ DoGetTxVector()

WifiTxVector ns3::HtPpdu::DoGetTxVector ( ) const

overrideprivatevirtual

Get the TXVECTOR used to send the PPDU.

Returns: the TXVECTOR of the PPDU.

Reimplemented from ns3::WifiPpdu.

Definition at line 78 of file ht-ppdu.cc.

References m_htSig, ns3::OfdmPpdu::m_lSig, ns3::WifiPpdu::m_preamble, ns3::WifiTxVector::SetPreambleType(), and SetTxVectorFromPhyHeaders().

Here is the call graph for this function:

◆ GetTxDuration()

Time ns3::HtPpdu::GetTxDuration ( ) const

overridevirtual

Get the total transmission duration of the PPDU.

Returns: the transmission duration of the PPDU

Reimplemented from ns3::WifiPpdu.

Definition at line 99 of file ht-ppdu.cc.

References ns3::WifiPhy::CalculateTxDuration(), ns3::HtPpdu::HtSigHeader::GetHtLength(), ns3::WifiPhyOperatingChannel::GetPhyBand(), ns3::WifiPpdu::GetTxVector(), ns3::WifiPhyOperatingChannel::IsSet(), m_htSig, ns3::WifiPpdu::m_operatingChannel, and NS_ASSERT.

Here is the call graph for this function:

◆ SetHtSigHeader()

void ns3::HtPpdu::SetHtSigHeader	(	HtSigHeader &	htSig,
		const WifiTxVector &	txVector,
		std::size_t	psduSize ) const

private

Fill in the HT-SIG header.

Parameters

htSig	the HT-SIG header to fill in
txVector	the TXVECTOR that was used for this PPDU
psduSize	the size duration of the PHY payload (PSDU)

Definition at line 68 of file ht-ppdu.cc.

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetGuardInterval(), ns3::WifiMode::GetMcsValue(), ns3::WifiTxVector::GetMode(), ns3::Time::GetNanoSeconds(), ns3::WifiTxVector::IsAggregation(), ns3::HtPpdu::HtSigHeader::SetAggregation(), ns3::HtPpdu::HtSigHeader::SetChannelWidth(), ns3::HtPpdu::HtSigHeader::SetHtLength(), ns3::HtPpdu::HtSigHeader::SetMcs(), and ns3::HtPpdu::HtSigHeader::SetShortGuardInterval().

Referenced by SetPhyHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLSigHeader()

void ns3::HtPpdu::SetLSigHeader	(	LSigHeader &	lSig,
		Time	ppduDuration ) const

privatevirtual

Fill in the L-SIG header.

Parameters

lSig	the L-SIG header to fill in
ppduDuration	the transmission duration of this PPDU

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

References ns3::Time::GetNanoSeconds(), ns3::WifiPhyOperatingChannel::GetPhyBand(), ns3::WifiPhyOperatingChannel::IsSet(), ns3::WifiPpdu::m_operatingChannel, NS_ASSERT, ns3::OfdmPpdu::LSigHeader::SetLength(), and ns3::WIFI_PHY_BAND_2_4GHZ.

Referenced by SetPhyHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPhyHeaders()

void ns3::HtPpdu::SetPhyHeaders	(	const WifiTxVector &	txVector,
		Time	ppduDuration,
		std::size_t	psduSize )

private

Fill in the PHY headers.

Parameters

txVector	the TXVECTOR that was used for this PPDU
ppduDuration	the transmission duration of this PPDU
psduSize	the size duration of the PHY payload (PSDU)

Definition at line 42 of file ht-ppdu.cc.

References m_htSig, ns3::OfdmPpdu::m_lSig, NS_LOG_FUNCTION, SetHtSigHeader(), and SetLSigHeader().

Referenced by HtPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTxVectorFromPhyHeaders()

void ns3::HtPpdu::SetTxVectorFromPhyHeaders	(	WifiTxVector &	txVector,
		const LSigHeader &	lSig,
		const HtSigHeader &	htSig ) const

private

Fill in the TXVECTOR from PHY headers.

Parameters

txVector	the TXVECTOR to fill in
lSig	the L-SIG header
htSig	the HT-SIG header

Definition at line 87 of file ht-ppdu.cc.

References ns3::HtPpdu::HtSigHeader::GetAggregation(), ns3::HtPpdu::HtSigHeader::GetChannelWidth(), ns3::HtPhy::GetHtMcs(), ns3::HtPpdu::HtSigHeader::GetMcs(), ns3::HtPpdu::HtSigHeader::GetShortGuardInterval(), ns3::NanoSeconds(), ns3::WifiTxVector::SetAggregation(), ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetMode(), and ns3::WifiTxVector::SetNss().

Referenced by DoGetTxVector().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_htSig

HtSigHeader ns3::HtPpdu::m_htSig

private

the HT-SIG PHY header

Definition at line 174 of file ht-ppdu.h.

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

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HtPpdu()

Member Function Documentation

◆ Copy()

◆ DoGetTxVector()

◆ GetTxDuration()

◆ SetHtSigHeader()

◆ SetLSigHeader()

◆ SetPhyHeaders()

◆ SetTxVectorFromPhyHeaders()

Member Data Documentation

◆ m_htSig