HE-SIG PHY header (HE-SIG-A1/A2/B) More...

#include "he-ppdu.h"

Inheritance diagram for ns3::HePpdu::HeSigHeader:

Collaboration diagram for ns3::HePpdu::HeSigHeader:

Public Member Functions
	HeSigHeader ()

virtual	~HeSigHeader ()

uint32_t	Deserialize (Buffer::Iterator start) override

uint8_t	GetBssColor (void) const
	Return the BSS Color field in the HE-SIG-A1. More...

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

uint16_t	GetGuardInterval (void) const
	Return the guard interval (in nanoseconds). 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 HE-SIG-A1. More...

uint8_t	GetNStreams (void) const
	Return the number of streams. More...

uint32_t	GetSerializedSize (void) const override

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

void	Serialize (Buffer::Iterator start) const override

void	SetBssColor (uint8_t bssColor)
	Fill the BSS Color field of HE-SIG-A1. More...

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

void	SetGuardIntervalAndLtfSize (uint16_t gi, uint8_t ltf)
	Fill the GI + LTF size field of HE-SIG-A1. More...

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

void	SetMuFlag (bool mu)
	Set the Multi-User (MU) flag. More...

void	SetNStreams (uint8_t nStreams)
	Fill the number of streams field of HE-SIG-A1. 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
uint8_t	m_bandwidth
	Bandwidth field. More...

uint8_t	m_bssColor
	BSS color field. More...

uint8_t	m_format
	Format bit. More...

uint8_t	m_gi_ltf_size
	GI+LTF Size field. More...

uint8_t	m_mcs
	MCS field. More...

bool	m_mu
	This is used to decide whether MU SIG-B should be added or not. More...

uint8_t	m_nsts
	NSTS. More...

uint8_t	m_spatialReuse
	Spatial Reuse field. More...

uint8_t	m_ul_dl
	UL/DL bit. 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

HE-SIG PHY header (HE-SIG-A1/A2/B)

Definition at line 51 of file he-ppdu.h.

Constructor & Destructor Documentation

◆ HeSigHeader()

ns3::HePpdu::HeSigHeader::HeSigHeader ( )

Definition at line 304 of file he-ppdu.cc.

◆ ~HeSigHeader()

ns3::HePpdu::HeSigHeader::~HeSigHeader ( )

virtual

Definition at line 317 of file he-ppdu.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::HePpdu::HeSigHeader::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 518 of file he-ppdu.cc.

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

Here is the call graph for this function:

◆ GetBssColor()

uint8_t ns3::HePpdu::HeSigHeader::GetBssColor ( void ) const

Return the BSS Color field in the HE-SIG-A1.

Returns: the BSS Color field in the HE-SIG-A1

Definition at line 389 of file he-ppdu.cc.

Referenced by ns3::HePpdu::DoGetTxVector(), and ns3::HePpdu::GetPsdu().

Here is the caller graph for this function:

◆ GetChannelWidth()

uint16_t ns3::HePpdu::HeSigHeader::GetChannelWidth ( void ) const

Return the channel width (in MHz).

Returns: the channel width (in MHz)

Definition at line 416 of file he-ppdu.cc.

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

Here is the caller graph for this function:

◆ GetGuardInterval()

uint16_t ns3::HePpdu::HeSigHeader::GetGuardInterval ( void ) const

Return the guard interval (in nanoseconds).

Returns: the guard interval (in nanoseconds)

Definition at line 458 of file he-ppdu.cc.

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

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::HePpdu::HeSigHeader::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 333 of file he-ppdu.cc.

◆ GetMcs()

uint8_t ns3::HePpdu::HeSigHeader::GetMcs ( void ) const

Return the MCS field of HE-SIG-A1.

Returns: the MCS field of HE-SIG-A1

Definition at line 376 of file he-ppdu.cc.

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

Here is the caller graph for this function:

◆ GetNStreams()

uint8_t ns3::HePpdu::HeSigHeader::GetNStreams ( void ) const

Return the number of streams.

Returns: the number of streams

Definition at line 483 of file he-ppdu.cc.

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

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::HePpdu::HeSigHeader::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 350 of file he-ppdu.cc.

◆ GetTypeId()

TypeId ns3::HePpdu::HeSigHeader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 322 of file he-ppdu.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Print()

void ns3::HePpdu::HeSigHeader::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 339 of file he-ppdu.cc.

◆ Serialize()

void ns3::HePpdu::HeSigHeader::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 489 of file he-ppdu.cc.

References visualizer.core::start().

Here is the call graph for this function:

◆ SetBssColor()

void ns3::HePpdu::HeSigHeader::SetBssColor ( uint8_t bssColor )

Fill the BSS Color field of HE-SIG-A1.

Parameters

bssColor the BSS Color value

Definition at line 382 of file he-ppdu.cc.

References NS_ASSERT.

Referenced by ns3::HePpdu::SetPhyHeaders().

Here is the caller graph for this function:

◆ SetChannelWidth()

void ns3::HePpdu::HeSigHeader::SetChannelWidth ( uint16_t channelWidth )

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

Parameters

channelWidth the channel width (in MHz)

Definition at line 395 of file he-ppdu.cc.

Referenced by ns3::HePpdu::SetPhyHeaders().

Here is the caller graph for this function:

◆ SetGuardIntervalAndLtfSize()

void ns3::HePpdu::HeSigHeader::SetGuardIntervalAndLtfSize	(	uint16_t	gi,
		uint8_t	ltf
	)

Fill the GI + LTF size field of HE-SIG-A1.

Parameters

gi	the guard interval (in nanoseconds)
ltf	the sequence of HE-LTF

Definition at line 437 of file he-ppdu.cc.

Referenced by ns3::HePpdu::SetPhyHeaders().

Here is the caller graph for this function:

◆ SetMcs()

void ns3::HePpdu::HeSigHeader::SetMcs ( uint8_t mcs )

Fill the MCS field of HE-SIG-A1.

Parameters

mcs	the MCS field of HE-SIG-A1

Definition at line 369 of file he-ppdu.cc.

References NS_ASSERT.

Referenced by ns3::HePpdu::SetPhyHeaders().

Here is the caller graph for this function:

◆ SetMuFlag()

void ns3::HePpdu::HeSigHeader::SetMuFlag ( bool mu )

Set the Multi-User (MU) flag.

Parameters

mu	the MU flag

Definition at line 363 of file he-ppdu.cc.

Referenced by ns3::HePpdu::SetPhyHeaders().

Here is the caller graph for this function:

◆ SetNStreams()

void ns3::HePpdu::HeSigHeader::SetNStreams ( uint8_t nStreams )

Fill the number of streams field of HE-SIG-A1.

Parameters

nStreams the number of streams

Definition at line 476 of file he-ppdu.cc.

References NS_ASSERT.

Referenced by ns3::HePpdu::SetPhyHeaders().

Here is the caller graph for this function:

Member Data Documentation

◆ m_bandwidth

uint8_t ns3::HePpdu::HeSigHeader::m_bandwidth

private

Bandwidth field.

Definition at line 145 of file he-ppdu.h.

◆ m_bssColor

uint8_t ns3::HePpdu::HeSigHeader::m_bssColor

private

BSS color field.

Definition at line 141 of file he-ppdu.h.

◆ m_format

uint8_t ns3::HePpdu::HeSigHeader::m_format

private

Format bit.

Definition at line 140 of file he-ppdu.h.

◆ m_gi_ltf_size

uint8_t ns3::HePpdu::HeSigHeader::m_gi_ltf_size

private

GI+LTF Size field.

Definition at line 146 of file he-ppdu.h.

◆ m_mcs

uint8_t ns3::HePpdu::HeSigHeader::m_mcs

private

MCS field.

Definition at line 143 of file he-ppdu.h.

◆ m_mu

bool ns3::HePpdu::HeSigHeader::m_mu

private

This is used to decide whether MU SIG-B should be added or not.

Definition at line 150 of file he-ppdu.h.

◆ m_nsts

uint8_t ns3::HePpdu::HeSigHeader::m_nsts

private

NSTS.

Definition at line 147 of file he-ppdu.h.

◆ m_spatialReuse

uint8_t ns3::HePpdu::HeSigHeader::m_spatialReuse

private

Spatial Reuse field.

Definition at line 144 of file he-ppdu.h.

◆ m_ul_dl

uint8_t ns3::HePpdu::HeSigHeader::m_ul_dl

private

UL/DL bit.

Definition at line 142 of file he-ppdu.h.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeSigHeader()

◆ ~HeSigHeader()

Member Function Documentation

◆ Deserialize()

◆ GetBssColor()

◆ GetChannelWidth()

◆ GetGuardInterval()

◆ GetInstanceTypeId()

◆ GetMcs()

◆ GetNStreams()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetBssColor()

◆ SetChannelWidth()

◆ SetGuardIntervalAndLtfSize()

◆ SetMcs()

◆ SetMuFlag()

◆ SetNStreams()

Member Data Documentation

◆ m_bandwidth

◆ m_bssColor

◆ m_format

◆ m_gi_ltf_size

◆ m_mcs

◆ m_mu

◆ m_nsts

◆ m_spatialReuse

◆ m_ul_dl