ns3::EhtOperation Class Reference

EHT Operation Information Element. More...

#include "eht-operation.h"

Inheritance diagram for ns3::EhtOperation:

Collaboration diagram for ns3::EhtOperation:

Classes
struct	EhtBasicMcsNssSet
	Basic EHT-MCS and NSS Set subfield IEEE 802.11be D2.0 Figure 9-1002ai. More...
struct	EhtOpControl
	EHT Operation Information Control subfield IEEE 802.11be D2.0 Figure 9-1002D. More...
struct	EhtOpInfo
	EHT Operation Information subfield IEEE 802.11be D2.0 Figure 9-1002c. More...
struct	EhtOpParams
	EHT Operation Parameters subfield IEEE 802.11be D2.0 Figure 9-1002b. More...

Public Member Functions
	EhtOperation ()
WifiInformationElementId	ElementId () const override
	Get the wifi information element ID. More...
WifiInformationElementId	ElementIdExt () const override
	Get the wifi information element ID extension. More...
void	Print (std::ostream &os) const override
	Generate human-readable form of IE. More...
void	SetMaxRxNss (uint8_t maxNss, uint8_t mcsStart, uint8_t mcsEnd)
	Set the max Rx NSS for input MCS index range. More...
void	SetMaxTxNss (uint8_t maxNss, uint8_t mcsStart, uint8_t mcsEnd)
	Set the max Tx NSS for input MCS index range. More...
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. More...
Buffer::Iterator	DeserializeIfPresent (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present. More...
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). More...
virtual bool	operator== (const WifiInformationElement &a) const
	Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
Buffer::Iterator	Serialize (Buffer::Iterator i) const
	Serialize entire IE including Element ID and length fields. More...
Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...
uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...
void	Ref () const
	Increment the reference count. More...
void	Unref () const
	Decrement the reference count. More...

Public Attributes
EhtBasicMcsNssSet	m_mcsNssSet
	Basic EHT-MCS and NSS set. More...
std::optional< EhtOpInfo >	m_opInfo
	EHT Operation Information. More...
EhtOpParams	m_params
	EHT Operation Parameters. More...

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) More...
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. More...
void	SerializeInformationField (Buffer::Iterator start) const override
	Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...

Detailed Description

EHT Operation Information Element.

This class serializes and deserializes the EHT Operation Information Element IEEE 802.11be D2.0 9.4.2.311

Definition at line 65 of file eht-operation.h.

Constructor & Destructor Documentation

EhtOperation()

ns3::EhtOperation::EhtOperation

(

)

Definition at line 188 of file eht-operation.cc.

References m_mcsNssSet, ns3::EhtOperation::EhtBasicMcsNssSet::maxRxNss, ns3::EhtOperation::EhtBasicMcsNssSet::maxTxNss, ns3::WIFI_DEFAULT_EHT_MAX_NSS, and ns3::WIFI_EHT_MAX_MCS_INDEX.

Member Function Documentation

DeserializeInformationField()

uint16_t ns3::EhtOperation::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 262 of file eht-operation.cc.

References ns3::EhtOperation::EhtOpParams::Deserialize(), ns3::EhtOperation::EhtBasicMcsNssSet::Deserialize(), ns3::EhtOperation::EhtOpParams::disabledSubchBmPresent, m_mcsNssSet, m_opInfo, m_params, NS_ABORT_MSG_IF, NS_ASSERT_MSG, ns3::EhtOperation::EhtOpParams::opInfoPresent, and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

ElementId()

WifiInformationElementId ns3::EhtOperation::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns

the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 195 of file eht-operation.cc.

References IE_EXTENSION.

ElementIdExt()

WifiInformationElementId ns3::EhtOperation::ElementIdExt ( ) const

overridevirtual

Get the wifi information element ID extension.

Returns

the wifi information element ID extension

Reimplemented from ns3::WifiInformationElement.

Definition at line 201 of file eht-operation.cc.

References IE_EXT_EHT_OPERATION.

GetInformationFieldSize()

uint16_t ns3::EhtOperation::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 207 of file eht-operation.cc.

References ns3::EhtOperation::EhtOpParams::disabledSubchBmPresent, m_params, ns3::EhtOperation::EhtOpParams::opInfoPresent, ns3::WIFI_EHT_BASIC_MCS_NSS_SET_SIZE_B, ns3::WIFI_EHT_DISABLED_SUBCH_BM_SIZE_B, ns3::WIFI_EHT_OP_INFO_BASIC_SIZE_B, ns3::WIFI_EHT_OP_PARAMS_SIZE_B, and ns3::WIFI_IE_ELEMENT_ID_EXT_SIZE.

Print()

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

overridevirtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 30 of file eht-operation.cc.

References ns3::EhtOperation::EhtOpParams::defaultPeDur, ns3::EhtOperation::EhtOpParams::disabledSubchBmPresent, ns3::EhtOperation::EhtOpParams::grpBuExp, ns3::EhtOperation::EhtOpParams::grpBuIndLimit, m_mcsNssSet, m_opInfo, m_params, ns3::EhtOperation::EhtBasicMcsNssSet::maxRxNss, ns3::EhtOperation::EhtBasicMcsNssSet::maxTxNss, and ns3::EhtOperation::EhtOpParams::opInfoPresent.

SerializeInformationField()

void ns3::EhtOperation::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 243 of file eht-operation.cc.

References ns3::EhtOperation::EhtOpParams::disabledSubchBmPresent, m_mcsNssSet, m_opInfo, m_params, NS_ASSERT_MSG, ns3::EhtOperation::EhtOpParams::opInfoPresent, ns3::EhtOperation::EhtOpParams::Serialize(), ns3::EhtOperation::EhtBasicMcsNssSet::Serialize(), and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

SetMaxRxNss()

void ns3::EhtOperation::SetMaxRxNss	(	uint8_t	maxNss,
		uint8_t	mcsStart,
		uint8_t	mcsEnd
	)

Set the max Rx NSS for input MCS index range.

Parameters

maxNss	the maximum supported Rx NSS for MCS group
mcsStart	MCS index start
mcsEnd	MCS index end

Definition at line 225 of file eht-operation.cc.

References m_mcsNssSet, ns3::EhtOperation::EhtBasicMcsNssSet::maxRxNss, NS_ASSERT, ns3::SetMaxNss(), ns3::WIFI_EHT_MAX_MCS_INDEX, and ns3::WIFI_EHT_MAX_NSS_CONFIGURABLE.

Referenced by EhtOperationElementTest::EhtOperationElementTest(), and ns3::ApWifiMac::GetEhtOperation().

Here is the call graph for this function:

Here is the caller graph for this function:

SetMaxTxNss()

void ns3::EhtOperation::SetMaxTxNss	(	uint8_t	maxNss,
		uint8_t	mcsStart,
		uint8_t	mcsEnd
	)

Set the max Tx NSS for input MCS index range.

Parameters

maxNss	the maximum supported Rx NSS for MCS group
mcsStart	MCS index start
mcsEnd	MCS index end

Definition at line 234 of file eht-operation.cc.

References m_mcsNssSet, ns3::EhtOperation::EhtBasicMcsNssSet::maxTxNss, NS_ASSERT, ns3::SetMaxNss(), ns3::WIFI_EHT_MAX_MCS_INDEX, and ns3::WIFI_EHT_MAX_NSS_CONFIGURABLE.

Referenced by EhtOperationElementTest::EhtOperationElementTest(), and ns3::ApWifiMac::GetEhtOperation().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_mcsNssSet

EhtBasicMcsNssSet ns3::EhtOperation::m_mcsNssSet

Basic EHT-MCS and NSS set.

Definition at line 181 of file eht-operation.h.

Referenced by EhtOperation(), DeserializeInformationField(), Print(), SerializeInformationField(), SetMaxRxNss(), and SetMaxTxNss().

m_opInfo

std::optional<EhtOpInfo> ns3::EhtOperation::m_opInfo

EHT Operation Information.

Definition at line 182 of file eht-operation.h.

Referenced by EhtOperationElementTest::EhtOperationElementTest(), DeserializeInformationField(), Print(), and SerializeInformationField().

m_params

EhtOpParams ns3::EhtOperation::m_params

EHT Operation Parameters.

Definition at line 180 of file eht-operation.h.

Referenced by EhtOperationElementTest::EhtOperationElementTest(), DeserializeInformationField(), GetInformationFieldSize(), Print(), and SerializeInformationField().

---

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

• src/wifi/model/eht/eht-operation.h
• src/wifi/model/eht/eht-operation.cc