A Discrete-Event Network Simulator
API
ns3::ErpOfdmPpdu Class Reference

ERP-OFDM PPDU (11g) More...

#include "erp-ofdm-ppdu.h"

+ Inheritance diagram for ns3::ErpOfdmPpdu:
+ Collaboration diagram for ns3::ErpOfdmPpdu:

Public Member Functions

 ErpOfdmPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, uint16_t txCenterFreq, WifiPhyBand band, uint64_t uid)
 Create an ERP-OFDM PPDU. More...
 
Ptr< WifiPpduCopy () const override
 Copy this instance. More...
 
- Public Member Functions inherited from ns3::OfdmPpdu
 OfdmPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, uint16_t txCenterFreq, WifiPhyBand band, uint64_t uid, bool instantiateLSig=true)
 Create an OFDM PPDU. More...
 
Ptr< WifiPpduCopy () const override
 Copy this instance. More...
 
Time GetTxDuration () 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, uint16_t txCenterFreq, uint64_t uid)
 Create a PPDU storing a map of PSDUs. More...
 
 WifiPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, uint16_t txCenterFreq, uint64_t uid=UINT64_MAX)
 Create a PPDU storing a PSDU. More...
 
virtual ~WifiPpdu ()
 Destructor for WifiPpdu. More...
 
bool DoesOverlapChannel (uint16_t minFreq, uint16_t maxFreq) const
 Check whether the given PPDU overlaps a given channel. More...
 
WifiModulationClass GetModulation () const
 Get the modulation used for the PPDU. More...
 
WifiPreamble GetPreamble () const
 Get the preamble of the PPDU. More...
 
Ptr< const WifiPsduGetPsdu () const
 Get the payload of the PPDU. More...
 
virtual uint16_t GetStaId () const
 Get the ID of the STA that transmitted the PPDU for UL MU, SU_STA_ID otherwise. More...
 
virtual uint16_t GetTransmissionChannelWidth () const
 Get the channel width over which the PPDU will effectively be transmitted. More...
 
uint16_t GetTxCenterFreq () const
 
const WifiTxVectorGetTxVector () const
 Get the TXVECTOR used to send the PPDU. More...
 
virtual WifiPpduType GetType () const
 Return the PPDU type (. More...
 
uint64_t GetUid () const
 Get the UID of the PPDU. More...
 
bool IsTruncatedTx () const
 
void Print (std::ostream &os) const
 Print the PPDU contents. More...
 
void ResetTxVector () const
 Reset the TXVECTOR. More...
 
void SetTruncatedTx ()
 Indicate that the PPDU's transmission was aborted due to transmitter switch off. More...
 
void UpdateTxVector (const WifiTxVector &updatedTxVector) const
 Update the TXVECTOR based on some information known at the receiver. 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 () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 

Private Member Functions

void SetTxVectorFromLSigHeader (WifiTxVector &txVector, const LSigHeader &lSig) const override
 Fill in the TXVECTOR from L-SIG header. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::WifiPpdu
virtual std::string PrintPayload () const
 Print the payload of the PPDU. More...
 
- Protected Attributes inherited from ns3::OfdmPpdu
WifiPhyBand m_band
 the WifiPhyBand used to transmit that PPDU More...
 
- Protected Attributes inherited from ns3::WifiPpdu
WifiModulationClass m_modulation
 the modulation used for the transmission of this PPDU More...
 
Ptr< Packetm_phyHeaders
 the PHY headers contained in this PPDU More...
 
WifiPreamble m_preamble
 the PHY preamble More...
 
WifiConstPsduMap m_psdus
 the PSDUs contained in this PPDU More...
 
uint16_t m_txCenterFreq
 the center frequency (MHz) used for the transmission of this PPDU More...
 
std::optional< WifiTxVectorm_txVector
 the TXVECTOR at TX PHY or the reconstructed TXVECTOR at RX PHY (or std::nullopt if TXVECTOR has not been reconstructed yet) More...
 
uint64_t m_uid
 the unique ID of this PPDU More...
 

Detailed Description

ERP-OFDM PPDU (11g)

ErpOfdmPpdu stores a preamble, PHY headers and a PSDU of a PPDU with non-HT header, i.e., PPDU that uses ERP-OFDM modulation.

Definition at line 44 of file erp-ofdm-ppdu.h.

Constructor & Destructor Documentation

◆ ErpOfdmPpdu()

ns3::ErpOfdmPpdu::ErpOfdmPpdu ( Ptr< const WifiPsdu psdu,
const WifiTxVector txVector,
uint16_t  txCenterFreq,
WifiPhyBand  band,
uint64_t  uid 
)

Create an ERP-OFDM PPDU.

Parameters
psduthe PHY payload (PSDU)
txVectorthe TXVECTOR that was used for this PPDU
txCenterFreqthe center frequency (MHz) that was used for this PPDU
bandthe WifiPhyBand used for the transmission of this PPDU
uidthe unique ID of this PPDU

Definition at line 33 of file erp-ofdm-ppdu.cc.

References NS_LOG_FUNCTION.

Referenced by Copy().

+ Here is the caller graph for this function:

Member Function Documentation

◆ Copy()

Ptr< WifiPpdu > ns3::ErpOfdmPpdu::Copy ( ) const
overridevirtual

Copy this instance.

Returns
a Ptr to a copy of this instance.

Reimplemented from ns3::WifiPpdu.

Definition at line 51 of file erp-ofdm-ppdu.cc.

References ErpOfdmPpdu().

+ Here is the call graph for this function:

◆ SetTxVectorFromLSigHeader()

void ns3::ErpOfdmPpdu::SetTxVectorFromLSigHeader ( WifiTxVector txVector,
const LSigHeader lSig 
) const
overrideprivatevirtual

Fill in the TXVECTOR from L-SIG header.

Parameters
txVectorthe TXVECTOR to fill in
lSigthe L-SIG header

Reimplemented from ns3::OfdmPpdu.

Definition at line 44 of file erp-ofdm-ppdu.cc.

References ns3::ErpOfdmPhy::GetErpOfdmRate(), ns3::OfdmPpdu::LSigHeader::GetRate(), ns3::WifiTxVector::SetChannelWidth(), and ns3::WifiTxVector::SetMode().

+ Here is the call graph for this function:

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