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

#include "ofdm-ppdu.h"

Inheritance diagram for ns3::OfdmPpdu::LSigHeader:

Collaboration diagram for ns3::OfdmPpdu::LSigHeader:

Public Member Functions
	LSigHeader ()

virtual	~LSigHeader ()

uint32_t	Deserialize (Buffer::Iterator start) override

TypeId	GetInstanceTypeId (void) const override
	Get the most derived TypeId for this Object. More...

uint16_t	GetLength (void) 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...

uint32_t	GetSerializedSize (void) const override

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

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...

Public Member Functions inherited from ns3::Header
virtual	~Header ()

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
uint16_t	m_length
	LENGTH field. More...

uint8_t	m_rate
	RATE field. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

OFDM and ERP OFDM L-SIG PHY header.

See section 17.3.4 in IEEE 802.11-2016.

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

Constructor & Destructor Documentation

◆ LSigHeader()

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

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

◆ ~LSigHeader()

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

virtual

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::OfdmPpdu::LSigHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

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

References ns3::Buffer::Iterator::GetDistanceFrom(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::OfdmPpdu::LSigHeader::GetInstanceTypeId ( void ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

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

◆ 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 225 of file ofdm-ppdu.cc.

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

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

channelWidth the channel width (in MHz)

Returns: the RATE field of L-SIG expressed in bit/s

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

References NS_ASSERT_MSG.

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

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::OfdmPpdu::LSigHeader::GetSerializedSize ( void ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

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

◆ GetTypeId()

TypeId ns3::OfdmPpdu::LSigHeader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Print()

void ns3::OfdmPpdu::LSigHeader::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

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

◆ Serialize()

void ns3::OfdmPpdu::LSigHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

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

References visualizer.core::start().

Here is the call graph for this function:

◆ SetLength()

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

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

Parameters

length the LENGTH field of L-SIG expressed in bytes

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

References NS_ASSERT_MSG.

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

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

rate	the RATE field of L-SIG expressed in bit/s
channelWidth	the channel width (in MHz)

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

References NS_ASSERT_MSG.

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

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 102 of file ofdm-ppdu.h.

◆ m_rate

uint8_t ns3::OfdmPpdu::LSigHeader::m_rate

private

RATE field.

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

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LSigHeader()

◆ ~LSigHeader()

Member Function Documentation

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetLength()

◆ GetRate()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetLength()

◆ SetRate()

Member Data Documentation

◆ m_length

◆ m_rate