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

The HE Operation Information Element. More...

#include "he-operation.h"

+ Inheritance diagram for ns3::HeOperation:
+ Collaboration diagram for ns3::HeOperation:

Classes

struct  BssColorInfo
 BSS Color Information field. More...
 
struct  HeOperationParams
 HE Operation Parameters field. More...
 
struct  OpInfo6GHz
 6 GHz Operation Information field More...
 

Public Member Functions

 HeOperation ()
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID.
 
WifiInformationElementId ElementIdExt () const override
 Get the wifi information element ID extension.
 
void Print (std::ostream &os) const override
 Generate human-readable form of IE.
 
void SetMaxHeMcsPerNss (uint8_t nss, uint8_t maxHeMcs)
 Set the Basic HE-MCS and NSS field in the HE Operation information element by specifying the pair (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.
 
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.
 
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

OptFieldWithPresenceInd< OpInfo6GHz > m_6GHzOpInfo
 6 GHz Operation Information field
 
uint16_t m_basicHeMcsAndNssSet
 Basic HE-MCS And NSS set (use setter to set value)
 
BssColorInfo m_bssColorInfo
 BSS Color Information field.
 
HeOperationParams m_heOpParams
 HE Operation Parameters 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 Operation Information Element.

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

Definition at line 26 of file he-operation.h.

Constructor & Destructor Documentation

◆ HeOperation()

ns3::HeOperation::HeOperation ( )

Definition at line 15 of file he-operation.cc.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::HeOperation::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 218 of file he-operation.cc.

References ns3::HeOperation::BssColorInfo::Deserialize(), ns3::HeOperation::HeOperationParams::Deserialize(), ns3::HeOperation::OpInfo6GHz::Deserialize(), ns3::Buffer::Iterator::GetDistanceFrom(), m_6GHzOpInfo, ns3::HeOperation::HeOperationParams::m_6GHzOpPresent, m_basicHeMcsAndNssSet, m_bssColorInfo, m_heOpParams, and ns3::Buffer::Iterator::ReadLsbtohU16().

+ Here is the call graph for this function:

◆ ElementId()

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

Get the wifi information element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 22 of file he-operation.cc.

References IE_EXTENSION.

◆ ElementIdExt()

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

Get the wifi information element ID extension.

Returns
the wifi information element ID extension

Reimplemented from ns3::WifiInformationElement.

Definition at line 28 of file he-operation.cc.

References IE_EXT_HE_OPERATION.

◆ GetInformationFieldSize()

uint16_t ns3::HeOperation::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 193 of file he-operation.cc.

References ns3::HeOperation::BssColorInfo::GetSerializedSize(), ns3::HeOperation::HeOperationParams::GetSerializedSize(), m_6GHzOpInfo, m_bssColorInfo, and m_heOpParams.

+ Here is the call graph for this function:

◆ Print()

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

Generate human-readable form of IE.

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 177 of file he-operation.cc.

References m_6GHzOpInfo, m_basicHeMcsAndNssSet, m_bssColorInfo, m_heOpParams, ns3::HeOperation::BssColorInfo::Print(), and ns3::HeOperation::HeOperationParams::Print().

+ Here is the call graph for this function:

◆ SerializeInformationField()

void ns3::HeOperation::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 205 of file he-operation.cc.

References m_6GHzOpInfo, m_basicHeMcsAndNssSet, m_bssColorInfo, m_heOpParams, ns3::HeOperation::BssColorInfo::Serialize(), and ns3::HeOperation::HeOperationParams::Serialize().

+ Here is the call graph for this function:

◆ SetMaxHeMcsPerNss()

void ns3::HeOperation::SetMaxHeMcsPerNss ( uint8_t nss,
uint8_t maxHeMcs )

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

Parameters
nssthe NSS
maxHeMcsthe maximum supported HE-MCS value corresponding to that NSS

Definition at line 149 of file he-operation.cc.

References m_basicHeMcsAndNssSet, and NS_ASSERT.

Referenced by HeOperationElementTest::DoRun(), and ns3::ApWifiMac::GetHeOperation().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_6GHzOpInfo

OptFieldWithPresenceInd<OpInfo6GHz> ns3::HeOperation::m_6GHzOpInfo

6 GHz Operation Information field

Definition at line 164 of file he-operation.h.

Referenced by DeserializeInformationField(), HeOperationElementTest::DoRun(), ns3::ApWifiMac::GetHeOperation(), GetInformationFieldSize(), Print(), and SerializeInformationField().

◆ m_basicHeMcsAndNssSet

uint16_t ns3::HeOperation::m_basicHeMcsAndNssSet

Basic HE-MCS And NSS set (use setter to set value)

Definition at line 163 of file he-operation.h.

Referenced by DeserializeInformationField(), Print(), SerializeInformationField(), and SetMaxHeMcsPerNss().

◆ m_bssColorInfo

BssColorInfo ns3::HeOperation::m_bssColorInfo

BSS Color Information field.

Definition at line 162 of file he-operation.h.

Referenced by DeserializeInformationField(), HeOperationElementTest::DoRun(), ns3::ApWifiMac::GetHeOperation(), GetInformationFieldSize(), Print(), and SerializeInformationField().

◆ m_heOpParams

HeOperationParams ns3::HeOperation::m_heOpParams

HE Operation Parameters field.

Definition at line 161 of file he-operation.h.

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

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