A Discrete-Event Network Simulator
API
ns3::VhtPpdu::VhtSigHeader Class Reference

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

#include "vht-ppdu.h"

+ Inheritance diagram for ns3::VhtPpdu::VhtSigHeader:
+ Collaboration diagram for ns3::VhtPpdu::VhtSigHeader:

Public Member Functions

 VhtSigHeader ()
 
virtual ~VhtSigHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
uint16_t GetChannelWidth (void) const
 Return the channel width (in MHz). More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint8_t GetNStreams (void) const
 Return the number of streams. More...
 
uint32_t GetSerializedSize (void) const
 
bool GetShortGuardInterval (void) const
 Return the short GI field of VHT-SIG-A2. More...
 
bool GetShortGuardIntervalDisambiguation (void) const
 Return the short GI NSYM disambiguation field of VHT-SIG-A2. More...
 
uint8_t GetSuMcs (void) const
 Return the SU VHT MCS field of VHT-SIG-A2. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetChannelWidth (uint16_t channelWidth)
 Fill the channel width field of VHT-SIG-A1 (in MHz). More...
 
void SetMuFlag (bool mu)
 Set the Multi-User (MU) flag. More...
 
void SetNStreams (uint8_t nStreams)
 Fill the number of streams field of VHT-SIG-A1. More...
 
void SetShortGuardInterval (bool sgi)
 Fill the short guard interval field of VHT-SIG-A2. More...
 
void SetShortGuardIntervalDisambiguation (bool disambiguation)
 Fill the short GI NSYM disambiguation field of VHT-SIG-A2. More...
 
void SetSuMcs (uint8_t mcs)
 Fill the SU VHT MCS field of VHT-SIG-A2. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 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_bw
 BW. 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_sgi
 Short GI. More...
 
uint8_t m_sgi_disambiguation
 Short GI NSYM Disambiguation. More...
 
uint8_t m_suMcs
 SU VHT MCS. 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...
 

Detailed Description

VHT PHY header (VHT-SIG-A1/A2/B).

See section 21.3.8 in IEEE 802.11-2016.

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

Constructor & Destructor Documentation

◆ VhtSigHeader()

ns3::VhtPpdu::VhtSigHeader::VhtSigHeader ( )

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

◆ ~VhtSigHeader()

ns3::VhtPpdu::VhtSigHeader::~VhtSigHeader ( )
virtual

Definition at line 108 of file vht-ppdu.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::VhtPpdu::VhtSigHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 277 of file vht-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:

◆ GetChannelWidth()

uint16_t ns3::VhtPpdu::VhtSigHeader::GetChannelWidth ( void  ) const

Return the channel width (in MHz).

Returns
the channel width (in MHz)

Definition at line 180 of file vht-ppdu.cc.

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

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::VhtPpdu::VhtSigHeader::GetInstanceTypeId ( void  ) const
virtual

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 124 of file vht-ppdu.cc.

◆ GetNStreams()

uint8_t ns3::VhtPpdu::VhtSigHeader::GetNStreams ( void  ) const

Return the number of streams.

Returns
the number of streams

Definition at line 208 of file vht-ppdu.cc.

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

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::VhtPpdu::VhtSigHeader::GetSerializedSize ( void  ) const
virtual
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 140 of file vht-ppdu.cc.

◆ GetShortGuardInterval()

bool ns3::VhtPpdu::VhtSigHeader::GetShortGuardInterval ( void  ) const

Return the short GI field of VHT-SIG-A2.

Returns
the short GI field of VHT-SIG-A2

Definition at line 220 of file vht-ppdu.cc.

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

+ Here is the caller graph for this function:

◆ GetShortGuardIntervalDisambiguation()

bool ns3::VhtPpdu::VhtSigHeader::GetShortGuardIntervalDisambiguation ( void  ) const

Return the short GI NSYM disambiguation field of VHT-SIG-A2.

Returns
the short GI NSYM disambiguation field of VHT-SIG-A2

Definition at line 232 of file vht-ppdu.cc.

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

+ Here is the caller graph for this function:

◆ GetSuMcs()

uint8_t ns3::VhtPpdu::VhtSigHeader::GetSuMcs ( void  ) const

Return the SU VHT MCS field of VHT-SIG-A2.

Returns
the SU VHT MCS field of VHT-SIG-A2

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

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

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::VhtPpdu::VhtSigHeader::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 113 of file vht-ppdu.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Print()

void ns3::VhtPpdu::VhtSigHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 130 of file vht-ppdu.cc.

◆ Serialize()

void ns3::VhtPpdu::VhtSigHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 251 of file vht-ppdu.cc.

References visualizer.core::start().

+ Here is the call graph for this function:

◆ SetChannelWidth()

void ns3::VhtPpdu::VhtSigHeader::SetChannelWidth ( uint16_t  channelWidth)

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

Parameters
channelWidththe channel width (in MHz)

Definition at line 159 of file vht-ppdu.cc.

Referenced by ns3::VhtPpdu::VhtPpdu().

+ Here is the caller graph for this function:

◆ SetMuFlag()

void ns3::VhtPpdu::VhtSigHeader::SetMuFlag ( bool  mu)

Set the Multi-User (MU) flag.

Parameters
muthe MU flag

Definition at line 153 of file vht-ppdu.cc.

Referenced by ns3::VhtPpdu::VhtPpdu().

+ Here is the caller graph for this function:

◆ SetNStreams()

void ns3::VhtPpdu::VhtSigHeader::SetNStreams ( uint8_t  nStreams)

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

Parameters
nStreamsthe number of streams

Definition at line 201 of file vht-ppdu.cc.

References NS_ASSERT.

Referenced by ns3::VhtPpdu::VhtPpdu().

+ Here is the caller graph for this function:

◆ SetShortGuardInterval()

void ns3::VhtPpdu::VhtSigHeader::SetShortGuardInterval ( bool  sgi)

Fill the short guard interval field of VHT-SIG-A2.

Parameters
sgiwhether short guard interval is used or not

Definition at line 214 of file vht-ppdu.cc.

Referenced by ns3::VhtPpdu::VhtPpdu().

+ Here is the caller graph for this function:

◆ SetShortGuardIntervalDisambiguation()

void ns3::VhtPpdu::VhtSigHeader::SetShortGuardIntervalDisambiguation ( bool  disambiguation)

Fill the short GI NSYM disambiguation field of VHT-SIG-A2.

Parameters
disambiguationwhether short GI NSYM disambiguation is set or not

Definition at line 226 of file vht-ppdu.cc.

Referenced by ns3::VhtPpdu::VhtPpdu().

+ Here is the caller graph for this function:

◆ SetSuMcs()

void ns3::VhtPpdu::VhtSigHeader::SetSuMcs ( uint8_t  mcs)

Fill the SU VHT MCS field of VHT-SIG-A2.

Parameters
mcsthe SU VHT MCS field of VHT-SIG-A2

Definition at line 238 of file vht-ppdu.cc.

References NS_ASSERT.

Referenced by ns3::VhtPpdu::VhtPpdu().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_bw

uint8_t ns3::VhtPpdu::VhtSigHeader::m_bw
private

BW.

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

◆ m_mu

bool ns3::VhtPpdu::VhtSigHeader::m_mu
private

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

Definition at line 151 of file vht-ppdu.h.

◆ m_nsts

uint8_t ns3::VhtPpdu::VhtSigHeader::m_nsts
private

NSTS.

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

◆ m_sgi

uint8_t ns3::VhtPpdu::VhtSigHeader::m_sgi
private

Short GI.

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

◆ m_sgi_disambiguation

uint8_t ns3::VhtPpdu::VhtSigHeader::m_sgi_disambiguation
private

Short GI NSYM Disambiguation.

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

◆ m_suMcs

uint8_t ns3::VhtPpdu::VhtSigHeader::m_suMcs
private

SU VHT MCS.

Definition at line 148 of file vht-ppdu.h.


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