A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Private Member Functions | List of all members
ns3::He6GhzBandCapabilities Class Reference
Wifi Models

The HE 6 GHz Band Capabilities (IEEE 802.11ax-2021 9.4.2.263) More...

#include "he-6ghz-band-capabilities.h"

+ Inheritance diagram for ns3::He6GhzBandCapabilities:
+ Collaboration diagram for ns3::He6GhzBandCapabilities:

Classes

struct  CapabilitiesInfo
 Capabilities Information field. More...
 

Public Member Functions

 He6GhzBandCapabilities ()
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID.
 
WifiInformationElementId ElementIdExt () const override
 Get the wifi information element ID extension.
 
uint32_t GetMaxAmpduLength () const
 Return the maximum A-MPDU length.
 
uint16_t GetMaxMpduLength () const
 Get the maximum MPDU length.
 
void Print (std::ostream &os) const override
 Generate human-readable form of IE.
 
void SetMaxAmpduLength (uint32_t maxAmpduLength)
 Set the maximum AMPDU length.
 
void SetMaxMpduLength (uint16_t length)
 Set the maximum MPDU length.
 
- 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.
 

Public Attributes

CapabilitiesInfo m_capabilitiesInfo
 capabilities field
 

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)
 

Detailed Description

The HE 6 GHz Band Capabilities (IEEE 802.11ax-2021 9.4.2.263)

Definition at line 33 of file he-6ghz-band-capabilities.h.

Constructor & Destructor Documentation

◆ He6GhzBandCapabilities()

ns3::He6GhzBandCapabilities::He6GhzBandCapabilities ( )

Definition at line 25 of file he-6ghz-band-capabilities.cc.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::He6GhzBandCapabilities::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
startan iterator which points to where the information should be written.
lengththe expected number of bytes to read
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 121 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxAmpduLengthExponent, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxMpduLength, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_minMpduStartSpacing, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_rdResponder, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_rxAntennaPatternConsistency, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_smPowerSave, and ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_txAntennaPatternConsistency.

◆ ElementId()

WifiInformationElementId ns3::He6GhzBandCapabilities::ElementId ( ) const
overridevirtual

Get the wifi information element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 31 of file he-6ghz-band-capabilities.cc.

References IE_EXTENSION.

◆ ElementIdExt()

WifiInformationElementId ns3::He6GhzBandCapabilities::ElementIdExt ( ) const
overridevirtual

Get the wifi information element ID extension.

Returns
the wifi information element ID extension

Reimplemented from ns3::WifiInformationElement.

Definition at line 37 of file he-6ghz-band-capabilities.cc.

References IE_EXT_HE_6GHZ_CAPABILITIES.

◆ GetInformationFieldSize()

uint16_t ns3::He6GhzBandCapabilities::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 43 of file he-6ghz-band-capabilities.cc.

◆ GetMaxAmpduLength()

uint32_t ns3::He6GhzBandCapabilities::GetMaxAmpduLength ( ) const

Return the maximum A-MPDU length.

Returns
the maximum A-MPDU length in bytes

Definition at line 65 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, and ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxAmpduLengthExponent.

◆ GetMaxMpduLength()

uint16_t ns3::He6GhzBandCapabilities::GetMaxMpduLength ( ) const

Get the maximum MPDU length.

Returns
the maximum MPDU length in bytes

Definition at line 90 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxMpduLength, and NS_ABORT_MSG.

◆ Print()

void ns3::He6GhzBandCapabilities::Print ( std::ostream &  os) const
overridevirtual

Generate human-readable form of IE.

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 136 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxAmpduLengthExponent, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxMpduLength, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_minMpduStartSpacing, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_rdResponder, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_rxAntennaPatternConsistency, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_smPowerSave, and ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_txAntennaPatternConsistency.

◆ SerializeInformationField()

void ns3::He6GhzBandCapabilities::SerializeInformationField ( Buffer::Iterator  start) const
overrideprivatevirtual

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

Parameters
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 108 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxAmpduLengthExponent, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxMpduLength, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_minMpduStartSpacing, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_rdResponder, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_rxAntennaPatternConsistency, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_smPowerSave, and ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_txAntennaPatternConsistency.

◆ SetMaxAmpduLength()

void ns3::He6GhzBandCapabilities::SetMaxAmpduLength ( uint32_t  maxAmpduLength)

Set the maximum AMPDU length.

Parameters
maxAmpduLength2^(13 + x) - 1, x in the range 0 to 7

Definition at line 51 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxAmpduLengthExponent, and NS_ABORT_MSG.

Referenced by He6GhzBandCapabilitiesTest::DoRun(), and ns3::WifiMac::GetHe6GhzBandCapabilities().

+ Here is the caller graph for this function:

◆ SetMaxMpduLength()

void ns3::He6GhzBandCapabilities::SetMaxMpduLength ( uint16_t  length)

Set the maximum MPDU length.

Parameters
lengththe maximum MPDU length (3895, 7991 or 11454)

Definition at line 71 of file he-6ghz-band-capabilities.cc.

References m_capabilitiesInfo, ns3::He6GhzBandCapabilities::CapabilitiesInfo::m_maxMpduLength, and NS_ABORT_MSG_IF.

Referenced by He6GhzBandCapabilitiesTest::DoRun(), and ns3::WifiMac::GetHe6GhzBandCapabilities().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_capabilitiesInfo

CapabilitiesInfo ns3::He6GhzBandCapabilities::m_capabilitiesInfo

capabilities field

Definition at line 58 of file he-6ghz-band-capabilities.h.

Referenced by DeserializeInformationField(), He6GhzBandCapabilitiesTest::DoRun(), GetMaxAmpduLength(), GetMaxMpduLength(), Print(), SerializeInformationField(), SetMaxAmpduLength(), and SetMaxMpduLength().

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