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

DSSS (HR/DSSS) PPDU (11b)DsssPpdu stores a preamble, PHY headers and a PSDU of a PPDU with DSSS modulation. 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, Time ppduDuration, uint64_t uid)
 Create a DSSS (HR/DSSS) PPDU. More...
 
virtual ~DsssPpdu ()
 Destructor for DsssPpdu. More...
 
Ptr< WifiPpduCopy (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 (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, uint64_t uid=UINT64_MAX)
 Create a PPDU storing a PSDU. More...
 
 WifiPpdu (const WifiConstPsduMap &psdus, const WifiTxVector &txVector, uint64_t uid)
 Create a PPDU storing a map of PSDUs. 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 WifiPsduGetPsdu (void) const
 Get the payload of the PPDU. More...
 
virtual uint16_t GetStaId (void) const
 Get the ID of the STA that transmitted the PPDU for UL MU, SU_STA_ID otherwise. More...
 
WifiTxVector GetTxVector (void) const
 Get the TXVECTOR used to send the PPDU. More...
 
virtual WifiPpduType GetType (void) const
 Return the PPDU type (. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Member Functions

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

Private Attributes

DsssSigHeader m_dsssSig
 the DSSS SIG PHY header More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::WifiPpdu
virtual std::string PrintPayload (void) const
 Print the payload of the PPDU. 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...
 

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 45 of file dsss-ppdu.h.

Constructor & Destructor Documentation

◆ DsssPpdu()

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

Create a DSSS (HR/DSSS) PPDU.

Parameters
psduthe PHY payload (PSDU)
txVectorthe TXVECTOR that was used for this PPDU
ppduDurationthe transmission duration of this PPDU
uidthe unique ID of this PPDU

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

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

+ Here is the call graph for this function:

◆ ~DsssPpdu()

ns3::DsssPpdu::~DsssPpdu ( )
virtual

Destructor for DsssPpdu.

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

Member Function Documentation

◆ Copy()

Ptr< WifiPpdu > ns3::DsssPpdu::Copy ( void  ) const
overridevirtual

Copy this instance.

Returns
a Ptr to a copy of this instance.

Reimplemented from ns3::WifiPpdu.

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

References ns3::WifiPpdu::GetPsdu(), GetTxDuration(), ns3::WifiPpdu::GetTxVector(), and ns3::WifiPpdu::m_uid.

+ Here is the call graph for this function:

◆ DoGetTxVector()

WifiTxVector ns3::DsssPpdu::DoGetTxVector ( void  ) const
overrideprivatevirtual

Get the TXVECTOR used to send the PPDU.

This method should be overridden by child classes.

Returns
the TXVECTOR of the PPDU.

Reimplemented from ns3::WifiPpdu.

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

References ns3::DsssPhy::GetDsssRate(), ns3::DsssPpdu::DsssSigHeader::GetRate(), m_dsssSig, ns3::WifiPpdu::m_preamble, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetMode(), and ns3::WifiTxVector::SetPreambleType().

+ Here is the call graph for this function:

◆ GetTxDuration()

Time ns3::DsssPpdu::GetTxDuration ( void  ) const
overridevirtual

Get the total transmission duration of the PPDU.

This method is overridden by child classes.

Returns
the transmission duration of the PPDU

Reimplemented from ns3::WifiPpdu.

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

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

Referenced by Copy().

+ 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(), DsssPpdu(), and GetTxDuration().


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