The VHT Operation Information Element. More...

#include "vht-operation.h"

Inheritance diagram for ns3::VhtOperation:

Collaboration diagram for ns3::VhtOperation:

Public Member Functions
	VhtOperation ()

WifiInformationElementId	ElementId () const override
	Get the wifi information element ID.

uint16_t	GetBasicVhtMcsAndNssSet () const
	Return the Basic VHT-MCS And Nss field in the VHT Operation information element.

uint8_t	GetChannelCenterFrequencySegment0 () const
	Return the Channel Center Frequency Segment 0 field in the VHT Operation information element.

uint8_t	GetChannelCenterFrequencySegment1 () const
	Return the Channel Center Frequency Segment 1 field in the VHT Operation information element.

uint8_t	GetChannelWidth () const
	Return the Channel Width field in the VHT Operation information element.

void	Print (std::ostream &os) const override
	Generate human-readable form of IE.

void	SetBasicVhtMcsAndNssSet (uint16_t basicVhtMcsAndNssSet)
	Set the Basic VHT-MCS and NSS field in the VHT Operation information element.

void	SetChannelCenterFrequencySegment0 (uint8_t channelCenterFrequencySegment0)
	Set the Channel Center Frequency Segment 0 field in the VHT Operation information element.

void	SetChannelCenterFrequencySegment1 (uint8_t channelCenterFrequencySegment1)
	Set the Channel Center Frequency Segment 1 field in the VHT Operation information element.

void	SetChannelWidth (uint8_t channelWidth)
	Set the Channel Width field in the VHT Operation information element.

void	SetMaxVhtMcsPerNss (uint8_t nss, uint8_t maxVhtMcs)
	Set the Basic VHT-MCS and NSS field in the VHT Operation information element by specifying the tuple (nss, maxMcs).

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

Buffer::Iterator	Deserialize (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements), which must be present.

Buffer::Iterator	DeserializeIfPresent (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present.

virtual WifiInformationElementId	ElementId () const =0
	Get the wifi information element ID.

virtual WifiInformationElementId	ElementIdExt () const
	Get the wifi information element ID extension.

uint16_t	GetSerializedSize () const
	Get the size of the serialized IE including Element ID and length fields (for every element this IE is possibly fragmented into).

virtual bool	operator== (const WifiInformationElement &a) const
	Compare two IEs for equality by ID & Length, and then through memcmp of serialised version.

virtual void	Print (std::ostream &os) const
	Generate human-readable form of IE.

Buffer::Iterator	Serialize (Buffer::Iterator i) const
	Serialize entire IE including Element ID and length fields.

Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Private Member Functions
uint16_t	DeserializeInformationField (Buffer::Iterator start, uint16_t length) override
	Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)

uint16_t	GetInformationFieldSize () const override
	Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets.

void	SerializeInformationField (Buffer::Iterator start) const override
	Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Private Attributes
uint16_t	m_basicVhtMcsAndNssSet
	basic VHT MCS NSS set

uint8_t	m_channelCenterFrequencySegment0
	channel center frequency segment 0

uint8_t	m_channelCenterFrequencySegment1
	channel center frequency segment 1

uint8_t	m_channelWidth
	channel width

Detailed Description

The VHT Operation Information Element.

This class knows how to serialise and deserialise the VHT Operation Information Element

Definition at line 35 of file vht-operation.h.

Constructor & Destructor Documentation

◆ VhtOperation()

ns3::VhtOperation::VhtOperation ( )

Definition at line 25 of file vht-operation.cc.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::VhtOperation::DeserializeInformationField	(	Buffer::Iterator	start,
		uint16_t	length
	)

overrideprivatevirtual

Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters

start	an iterator which points to where the information should be written.
length	the expected number of bytes to read

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 125 of file vht-operation.cc.

References ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), SetBasicVhtMcsAndNssSet(), SetChannelCenterFrequencySegment0(), SetChannelCenterFrequencySegment1(), and SetChannelWidth().

Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::VhtOperation::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 34 of file vht-operation.cc.

References IE_VHT_OPERATION.

◆ GetBasicVhtMcsAndNssSet()

uint16_t ns3::VhtOperation::GetBasicVhtMcsAndNssSet ( ) const

Return the Basic VHT-MCS And Nss field in the VHT Operation information element.

Returns: the Basic VHT-MCS And Nss field in the VHT Operation information element

Definition at line 109 of file vht-operation.cc.

References m_basicVhtMcsAndNssSet.

Referenced by Print(), and SerializeInformationField().

Here is the caller graph for this function:

◆ GetChannelCenterFrequencySegment0()

uint8_t ns3::VhtOperation::GetChannelCenterFrequencySegment0 ( ) const

Return the Channel Center Frequency Segment 0 field in the VHT Operation information element.

Returns: the Channel Center Frequency Segment 0 field in the VHT Operation information element

Definition at line 97 of file vht-operation.cc.

References m_channelCenterFrequencySegment0.

Referenced by Print(), and SerializeInformationField().

Here is the caller graph for this function:

◆ GetChannelCenterFrequencySegment1()

uint8_t ns3::VhtOperation::GetChannelCenterFrequencySegment1 ( ) const

Return the Channel Center Frequency Segment 1 field in the VHT Operation information element.

Returns: the Channel Center Frequency Segment 1 field in the VHT Operation information element

Definition at line 103 of file vht-operation.cc.

References m_channelCenterFrequencySegment1.

Referenced by Print(), and SerializeInformationField().

Here is the caller graph for this function:

◆ GetChannelWidth()

uint8_t ns3::VhtOperation::GetChannelWidth ( ) const

Return the Channel Width field in the VHT Operation information element.

Returns: the Channel Width field in the VHT Operation information element

Definition at line 91 of file vht-operation.cc.

References m_channelWidth.

Referenced by Print(), and SerializeInformationField().

Here is the caller graph for this function:

◆ GetInformationFieldSize()

uint16_t ns3::VhtOperation::GetInformationFieldSize ( ) const

overrideprivatevirtual

Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets.

This is the value that will appear in the second octet of the entire IE - the length field - if the IE is not fragmented)

Returns: the length of serialized information

Implements ns3::WifiInformationElement.

Definition at line 47 of file vht-operation.cc.

◆ Print()

void ns3::VhtOperation::Print ( std::ostream & os ) const

overridevirtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 40 of file vht-operation.cc.

References GetBasicVhtMcsAndNssSet(), GetChannelCenterFrequencySegment0(), GetChannelCenterFrequencySegment1(), and GetChannelWidth().

Here is the call graph for this function:

◆ SerializeInformationField()

void ns3::VhtOperation::SerializeInformationField ( Buffer::Iterator start ) const

overrideprivatevirtual

Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters

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

Implements ns3::WifiInformationElement.

Definition at line 115 of file vht-operation.cc.

References GetBasicVhtMcsAndNssSet(), GetChannelCenterFrequencySegment0(), GetChannelCenterFrequencySegment1(), and GetChannelWidth().

Here is the call graph for this function:

◆ SetBasicVhtMcsAndNssSet()

void ns3::VhtOperation::SetBasicVhtMcsAndNssSet ( uint16_t basicVhtMcsAndNssSet )

Set the Basic VHT-MCS and NSS field in the VHT Operation information element.

Parameters

basicVhtMcsAndNssSet the Basic VHT-MCS and NSS field in the VHT Operation information element

Definition at line 85 of file vht-operation.cc.

References m_basicVhtMcsAndNssSet.

Referenced by DeserializeInformationField().

Here is the caller graph for this function:

◆ SetChannelCenterFrequencySegment0()

void ns3::VhtOperation::SetChannelCenterFrequencySegment0 ( uint8_t channelCenterFrequencySegment0 )

Set the Channel Center Frequency Segment 0 field in the VHT Operation information element.

Parameters

channelCenterFrequencySegment0 the Channel Center Frequency Segment 0 field in the VHT Operation information element

Definition at line 59 of file vht-operation.cc.

References m_channelCenterFrequencySegment0.

Referenced by DeserializeInformationField(), and ns3::ApWifiMac::GetVhtOperation().

Here is the caller graph for this function:

◆ SetChannelCenterFrequencySegment1()

void ns3::VhtOperation::SetChannelCenterFrequencySegment1 ( uint8_t channelCenterFrequencySegment1 )

Set the Channel Center Frequency Segment 1 field in the VHT Operation information element.

Parameters

channelCenterFrequencySegment1 the Channel Center Frequency Segment 1 field in the VHT Operation information element

Definition at line 65 of file vht-operation.cc.

References m_channelCenterFrequencySegment1.

Referenced by DeserializeInformationField(), and ns3::ApWifiMac::GetVhtOperation().

Here is the caller graph for this function:

◆ SetChannelWidth()

void ns3::VhtOperation::SetChannelWidth ( uint8_t channelWidth )

Set the Channel Width field in the VHT Operation information element.

Parameters

channelWidth the Channel Width field in the VHT Operation information element

Definition at line 53 of file vht-operation.cc.

References m_channelWidth.

Referenced by DeserializeInformationField(), and ns3::ApWifiMac::GetVhtOperation().

Here is the caller graph for this function:

◆ SetMaxVhtMcsPerNss()

void ns3::VhtOperation::SetMaxVhtMcsPerNss	(	uint8_t	nss,
		uint8_t	maxVhtMcs
	)

Set the Basic VHT-MCS and NSS field in the VHT Operation information element by specifying the tuple (nss, maxMcs).

Parameters

nss	the NSS
maxVhtMcs	the maximum supported VHT-MCS value corresponding to that NSS

Definition at line 71 of file vht-operation.cc.

References m_basicVhtMcsAndNssSet, and NS_ASSERT.

Referenced by ns3::ApWifiMac::GetVhtOperation().

Here is the caller graph for this function:

Member Data Documentation

◆ m_basicVhtMcsAndNssSet

uint16_t ns3::VhtOperation::m_basicVhtMcsAndNssSet

private

basic VHT MCS NSS set

Definition at line 116 of file vht-operation.h.

Referenced by GetBasicVhtMcsAndNssSet(), SetBasicVhtMcsAndNssSet(), and SetMaxVhtMcsPerNss().

◆ m_channelCenterFrequencySegment0

uint8_t ns3::VhtOperation::m_channelCenterFrequencySegment0

private

channel center frequency segment 0

Definition at line 112 of file vht-operation.h.

Referenced by GetChannelCenterFrequencySegment0(), and SetChannelCenterFrequencySegment0().

◆ m_channelCenterFrequencySegment1

uint8_t ns3::VhtOperation::m_channelCenterFrequencySegment1

private

channel center frequency segment 1

Definition at line 113 of file vht-operation.h.

Referenced by GetChannelCenterFrequencySegment1(), and SetChannelCenterFrequencySegment1().

◆ m_channelWidth

uint8_t ns3::VhtOperation::m_channelWidth

private

channel width

Definition at line 111 of file vht-operation.h.

Referenced by GetChannelWidth(), and SetChannelWidth().

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

src/wifi/model/vht/vht-operation.h
src/wifi/model/vht/vht-operation.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VhtOperation()

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetBasicVhtMcsAndNssSet()

◆ GetChannelCenterFrequencySegment0()

◆ GetChannelCenterFrequencySegment1()

◆ GetChannelWidth()

◆ GetInformationFieldSize()

◆ Print()

◆ SerializeInformationField()

◆ SetBasicVhtMcsAndNssSet()

◆ SetChannelCenterFrequencySegment0()

◆ SetChannelCenterFrequencySegment1()

◆ SetChannelWidth()

◆ SetMaxVhtMcsPerNss()

Member Data Documentation

◆ m_basicVhtMcsAndNssSet

◆ m_channelCenterFrequencySegment0

◆ m_channelCenterFrequencySegment1

◆ m_channelWidth