DSSS (HR/DSSS) PPDU (11b) More...

#include "dsss-ppdu.h"

Inheritance diagram for ns3::DsssPpdu:

Collaboration diagram for ns3::DsssPpdu:

Classes
class	DsssSigHeader
	DSSS SIG PHY header. More...

Public Member Functions
	DsssPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, const WifiPhyOperatingChannel &channel, Time ppduDuration, uint64_t uid)
	Create a DSSS (HR/DSSS) 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	SetDsssHeader (DsssSigHeader &dsssSig, const WifiTxVector &txVector, Time ppduDuration) const
	Fill in the DSSS header.

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

virtual void	SetTxVectorFromDsssHeader (WifiTxVector &txVector, const DsssSigHeader &dsssSig) const
	Fill in the TXVECTOR from DSSS header.

Private Attributes
DsssSigHeader	m_dsssSig
	the DSSS 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::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

DSSS (HR/DSSS) PPDU (11b)

DsssPpdu stores a preamble, PHY headers and a PSDU of a PPDU with DSSS modulation.

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

Constructor & Destructor Documentation

◆ DsssPpdu()

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

Create a DSSS (HR/DSSS) 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 25 of file dsss-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::DsssPpdu::Copy ( ) const

overridevirtual

Copy this instance.

Returns: a Ptr to a copy of this instance.

Reimplemented from ns3::WifiPpdu.

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

References DsssPpdu().

Here is the call graph for this function:

◆ DoGetTxVector()

WifiTxVector ns3::DsssPpdu::DoGetTxVector ( ) const

overrideprivatevirtual

Get the TXVECTOR used to send the PPDU.

Returns: the TXVECTOR of the PPDU.

Reimplemented from ns3::WifiPpdu.

Definition at line 54 of file dsss-ppdu.cc.

References m_dsssSig, ns3::WifiPpdu::m_preamble, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetPreambleType(), and SetTxVectorFromDsssHeader().

Here is the call graph for this function:

◆ GetTxDuration()

Time ns3::DsssPpdu::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 70 of file dsss-ppdu.cc.

References ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::DsssPpdu::DsssSigHeader::GetLength(), ns3::WifiPpdu::GetTxVector(), m_dsssSig, and ns3::MicroSeconds().

Here is the call graph for this function:

◆ SetDsssHeader()

void ns3::DsssPpdu::SetDsssHeader	(	DsssSigHeader &	dsssSig,
		const WifiTxVector &	txVector,
		Time	ppduDuration ) const

private

Fill in the DSSS header.

Parameters

dsssSig	the DSSS header to fill in
txVector	the TXVECTOR that was used for this PPDU
ppduDuration	the transmission duration of this PPDU

Definition at line 44 of file dsss-ppdu.cc.

References ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::WifiMode::GetDataRate(), ns3::Time::GetMicroSeconds(), ns3::WifiTxVector::GetMode(), ns3::DsssPpdu::DsssSigHeader::SetLength(), and ns3::DsssPpdu::DsssSigHeader::SetRate().

Referenced by SetPhyHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPhyHeaders()

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

private

Fill in the PHY headers.

Parameters

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

Definition at line 37 of file dsss-ppdu.cc.

References m_dsssSig, NS_LOG_FUNCTION, and SetDsssHeader().

Referenced by DsssPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTxVectorFromDsssHeader()

void ns3::DsssPpdu::SetTxVectorFromDsssHeader	(	WifiTxVector &	txVector,
		const DsssSigHeader &	dsssSig ) const

privatevirtual

Fill in the TXVECTOR from DSSS header.

Parameters

txVector	the TXVECTOR to fill in
dsssSig	the DSSS header

Definition at line 64 of file dsss-ppdu.cc.

References ns3::DsssPhy::GetDsssRate(), ns3::DsssPpdu::DsssSigHeader::GetRate(), and ns3::WifiTxVector::SetMode().

Referenced by DoGetTxVector().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_dsssSig

DsssSigHeader ns3::DsssPpdu::m_dsssSig

private

the DSSS SIG PHY header

Definition at line 124 of file dsss-ppdu.h.

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

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DsssPpdu()

Member Function Documentation

◆ Copy()

◆ DoGetTxVector()

◆ GetTxDuration()

◆ SetDsssHeader()

◆ SetPhyHeaders()

◆ SetTxVectorFromDsssHeader()

Member Data Documentation

◆ m_dsssSig