A Discrete-Event Network Simulator
API
ns3::OfdmPpdu::LSigHeader Class Reference

OFDM and ERP OFDM L-SIG PHY header. More...

#include "ofdm-ppdu.h"

+ Collaboration diagram for ns3::OfdmPpdu::LSigHeader:

Public Member Functions

 LSigHeader ()
 
uint16_t GetLength () const
 Return the LENGTH field of L-SIG (in bytes). More...
 
uint64_t GetRate (uint16_t channelWidth=20) const
 Return the RATE field of L-SIG (in bit/s). More...
 
void SetLength (uint16_t length)
 Fill the LENGTH field of L-SIG (in bytes). More...
 
void SetRate (uint64_t rate, uint16_t channelWidth=20)
 Fill the RATE field of L-SIG (in bit/s). More...
 

Private Attributes

uint16_t m_length
 LENGTH field. More...
 
uint8_t m_rate
 RATE field. More...
 

Detailed Description

OFDM and ERP OFDM L-SIG PHY header.

See section 17.3.4 in IEEE 802.11-2016.

Definition at line 53 of file ofdm-ppdu.h.

Constructor & Destructor Documentation

◆ LSigHeader()

ns3::OfdmPpdu::LSigHeader::LSigHeader ( )

Definition at line 98 of file ofdm-ppdu.cc.

Member Function Documentation

◆ GetLength()

uint16_t ns3::OfdmPpdu::LSigHeader::GetLength ( void  ) const

Return the LENGTH field of L-SIG (in bytes).

Returns
the LENGTH field of L-SIG expressed in bytes

Definition at line 210 of file ofdm-ppdu.cc.

Referenced by ns3::OfdmPpdu::GetTxDuration(), ns3::VhtPpdu::GetTxDuration(), ns3::HePpdu::SetTxVectorFromPhyHeaders(), and ns3::EhtPpdu::SetTxVectorFromPhyHeaders().

+ Here is the caller graph for this function:

◆ GetRate()

uint64_t ns3::OfdmPpdu::LSigHeader::GetRate ( uint16_t  channelWidth = 20) const

Return the RATE field of L-SIG (in bit/s).

Parameters
channelWidththe channel width (in MHz)
Returns
the RATE field of L-SIG expressed in bit/s

Definition at line 158 of file ofdm-ppdu.cc.

References NS_ASSERT_MSG.

Referenced by ns3::OfdmPpdu::SetTxVectorFromLSigHeader(), and ns3::ErpOfdmPpdu::SetTxVectorFromLSigHeader().

+ Here is the caller graph for this function:

◆ SetLength()

void ns3::OfdmPpdu::LSigHeader::SetLength ( uint16_t  length)

Fill the LENGTH field of L-SIG (in bytes).

Parameters
lengththe LENGTH field of L-SIG expressed in bytes

Definition at line 203 of file ofdm-ppdu.cc.

References NS_ASSERT_MSG.

Referenced by ns3::OfdmPpdu::SetLSigHeader(), ns3::HtPpdu::SetLSigHeader(), ns3::VhtPpdu::SetLSigHeader(), and ns3::HePpdu::SetLSigHeader().

+ Here is the caller graph for this function:

◆ SetRate()

void ns3::OfdmPpdu::LSigHeader::SetRate ( uint64_t  rate,
uint16_t  channelWidth = 20 
)

Fill the RATE field of L-SIG (in bit/s).

Parameters
ratethe RATE field of L-SIG expressed in bit/s
channelWidththe channel width (in MHz)

Definition at line 105 of file ofdm-ppdu.cc.

References NS_ASSERT_MSG.

Referenced by ns3::OfdmPpdu::SetLSigHeader().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_length

uint16_t ns3::OfdmPpdu::LSigHeader::m_length
private

LENGTH field.

Definition at line 87 of file ofdm-ppdu.h.

◆ m_rate

uint8_t ns3::OfdmPpdu::LSigHeader::m_rate
private

RATE field.

Definition at line 86 of file ofdm-ppdu.h.


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