HT PHY header (HT-SIG1/2). More...

#include "ht-ppdu.h"

Inheritance diagram for ns3::HtPpdu::HtSigHeader:

Collaboration diagram for ns3::HtPpdu::HtSigHeader:

Public Member Functions
	HtSigHeader ()

virtual	~HtSigHeader ()

uint32_t	Deserialize (Buffer::Iterator start) override

bool	GetAggregation (void) const
	Return the aggregation field of HT-SIG. More...

uint16_t	GetChannelWidth (void) const
	Return the channel width (in MHz). More...

uint16_t	GetHtLength (void) const
	Return the HT length field of HT-SIG (in bytes). More...

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

uint8_t	GetMcs (void) const
	Return the MCS field of HT-SIG. More...

uint32_t	GetSerializedSize (void) const override

bool	GetShortGuardInterval (void) const
	Return the short guard interval field of HT-SIG. More...

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

void	Serialize (Buffer::Iterator start) const override

void	SetAggregation (bool aggregation)
	Fill the aggregation field of HT-SIG. More...

void	SetChannelWidth (uint16_t channelWidth)
	Fill the channel width field of HT-SIG (in MHz). More...

void	SetHtLength (uint16_t length)
	Fill the HT length field of HT-SIG (in bytes). More...

void	SetMcs (uint8_t mcs)
	Fill the MCS field of HT-SIG. More...

void	SetShortGuardInterval (bool sgi)
	Fill the short guard interval field of HT-SIG. 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)=0

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

virtual uint32_t	GetSerializedSize (void) const =0

virtual void	Print (std::ostream &os) const =0

virtual void	Serialize (Buffer::Iterator start) const =0

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

virtual void	Print (std::ostream &os) const =0
	Print the object contents. 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...

virtual TypeId	GetInstanceTypeId (void) const =0
	Get the most derived TypeId for this Object. 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
uint8_t	m_aggregation
	Aggregation. More...

uint8_t	m_cbw20_40
	CBW 20/40. More...

uint16_t	m_htLength
	HT length. More...

uint8_t	m_mcs
	Modulation and Coding Scheme index. More...

uint8_t	m_sgi
	Short Guard Interval. 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

HT PHY header (HT-SIG1/2).

See section 19.3.9 in IEEE 802.11-2016.

Definition at line 52 of file ht-ppdu.h.

Constructor & Destructor Documentation

◆ HtSigHeader()

ns3::HtPpdu::HtSigHeader::HtSigHeader ( )

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

◆ ~HtSigHeader()

ns3::HtPpdu::HtSigHeader::~HtSigHeader ( )

virtual

Definition at line 94 of file ht-ppdu.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::HtPpdu::HtSigHeader::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 207 of file ht-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:

◆ GetAggregation()

bool ns3::HtPpdu::HtSigHeader::GetAggregation ( void ) const

Return the aggregation field of HT-SIG.

Returns: the aggregation field of HT-SIG

Definition at line 175 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::DoGetTxVector().

Here is the caller graph for this function:

◆ GetChannelWidth()

uint16_t ns3::HtPpdu::HtSigHeader::GetChannelWidth ( void ) const

Return the channel width (in MHz).

Returns: the channel width (in MHz)

Definition at line 151 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::DoGetTxVector().

Here is the caller graph for this function:

◆ GetHtLength()

uint16_t ns3::HtPpdu::HtSigHeader::GetHtLength ( void ) const

Return the HT length field of HT-SIG (in bytes).

Returns: the HT length field of HT-SIG (in bytes)

Definition at line 163 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::GetTxDuration().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::HtPpdu::HtSigHeader::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 110 of file ht-ppdu.cc.

◆ GetMcs()

uint8_t ns3::HtPpdu::HtSigHeader::GetMcs ( void ) const

Return the MCS field of HT-SIG.

Returns: the MCS field of HT-SIG

Definition at line 139 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::DoGetTxVector().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::HtPpdu::HtSigHeader::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 126 of file ht-ppdu.cc.

◆ GetShortGuardInterval()

bool ns3::HtPpdu::HtSigHeader::GetShortGuardInterval ( void ) const

Return the short guard interval field of HT-SIG.

Returns: the short guard interval field of HT-SIG

Definition at line 187 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::DoGetTxVector().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::HtPpdu::HtSigHeader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 99 of file ht-ppdu.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Print()

void ns3::HtPpdu::HtSigHeader::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 116 of file ht-ppdu.cc.

◆ Serialize()

void ns3::HtPpdu::HtSigHeader::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 193 of file ht-ppdu.cc.

References visualizer.core::start().

Here is the call graph for this function:

◆ SetAggregation()

void ns3::HtPpdu::HtSigHeader::SetAggregation ( bool aggregation )

Fill the aggregation field of HT-SIG.

Parameters

aggregation whether the PSDU contains A-MPDU or not

Definition at line 169 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::HtPpdu().

Here is the caller graph for this function:

◆ SetChannelWidth()

void ns3::HtPpdu::HtSigHeader::SetChannelWidth ( uint16_t channelWidth )

Fill the channel width field of HT-SIG (in MHz).

Parameters

channelWidth the channel width (in MHz)

Definition at line 145 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::HtPpdu().

Here is the caller graph for this function:

◆ SetHtLength()

void ns3::HtPpdu::HtSigHeader::SetHtLength ( uint16_t length )

Fill the HT length field of HT-SIG (in bytes).

Parameters

length the HT length field of HT-SIG (in bytes)

Definition at line 157 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::HtPpdu().

Here is the caller graph for this function:

◆ SetMcs()

void ns3::HtPpdu::HtSigHeader::SetMcs ( uint8_t mcs )

Fill the MCS field of HT-SIG.

Parameters

mcs	the MCS field of HT-SIG

Definition at line 132 of file ht-ppdu.cc.

References NS_ASSERT.

Referenced by ns3::HtPpdu::HtPpdu().

Here is the caller graph for this function:

◆ SetShortGuardInterval()

void ns3::HtPpdu::HtSigHeader::SetShortGuardInterval ( bool sgi )

Fill the short guard interval field of HT-SIG.

Parameters

sgi	whether short guard interval is used or not

Definition at line 181 of file ht-ppdu.cc.

Referenced by ns3::HtPpdu::HtPpdu().

Here is the caller graph for this function:

Member Data Documentation

◆ m_aggregation

uint8_t ns3::HtPpdu::HtSigHeader::m_aggregation

private

Aggregation.

Definition at line 135 of file ht-ppdu.h.

◆ m_cbw20_40

uint8_t ns3::HtPpdu::HtSigHeader::m_cbw20_40

private

CBW 20/40.

Definition at line 133 of file ht-ppdu.h.

◆ m_htLength

uint16_t ns3::HtPpdu::HtSigHeader::m_htLength

private

HT length.

Definition at line 134 of file ht-ppdu.h.

◆ m_mcs

uint8_t ns3::HtPpdu::HtSigHeader::m_mcs

private

Modulation and Coding Scheme index.

Definition at line 132 of file ht-ppdu.h.

◆ m_sgi

uint8_t ns3::HtPpdu::HtSigHeader::m_sgi

private

Short Guard Interval.

Definition at line 136 of file ht-ppdu.h.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HtSigHeader()

◆ ~HtSigHeader()

Member Function Documentation

◆ Deserialize()

◆ GetAggregation()

◆ GetChannelWidth()

◆ GetHtLength()

◆ GetInstanceTypeId()

◆ GetMcs()

◆ GetSerializedSize()

◆ GetShortGuardInterval()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetAggregation()

◆ SetChannelWidth()

◆ SetHtLength()

◆ SetMcs()

◆ SetShortGuardInterval()

Member Data Documentation

◆ m_aggregation

◆ m_cbw20_40

◆ m_htLength

◆ m_mcs

◆ m_sgi