A Discrete-Event Network Simulator
API
ns3::VhtOperation Class Reference

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. More...
 
uint16_t GetBasicVhtMcsAndNssSet (void) const
 Return the Basic VHT-MCS And Nss field in the VHT Operation information element. More...
 
uint8_t GetChannelCenterFrequencySegment0 (void) const
 Return the Channel Center Frequency Segment 0 field in the VHT Operation information element. More...
 
uint8_t GetChannelCenterFrequencySegment1 (void) const
 Return the Channel Center Frequency Segment 1 field in the VHT Operation information element. More...
 
uint8_t GetChannelWidth (void) const
 Return the Channel Width field in the VHT Operation information element. More...
 
void SetBasicVhtMcsAndNssSet (uint16_t basicVhtMcsAndNssSet)
 Set the Basic VHT-MCS and NSS field in the VHT Operation information element. More...
 
void SetChannelCenterFrequencySegment0 (uint8_t channelCenterFrequencySegment0)
 Set the Channel Center Frequency Segment 0 field in the VHT Operation information element. More...
 
void SetChannelCenterFrequencySegment1 (uint8_t channelCenterFrequencySegment1)
 Set the Channel Center Frequency Segment 1 field in the VHT Operation information element. More...
 
void SetChannelWidth (uint8_t channelWidth)
 Set the Channel Width field in the VHT Operation information element. More...
 
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). 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...
 
virtual WifiInformationElementId ElementId () const =0
 Get the wifi information element ID. More...
 
virtual WifiInformationElementId ElementIdExt () const
 Get the wifi information element ID extension. 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== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
 
virtual void Print (std::ostream &os) const
 Generate human-readable form of IE. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. 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...
 

Private Attributes

uint16_t m_basicVhtMcsAndNssSet
 basic VHT MCS NSS set More...
 
uint8_t m_channelCenterFrequencySegment0
 channel center frequency segment 0 More...
 
uint8_t m_channelCenterFrequencySegment1
 channel center frequency segment 1 More...
 
uint8_t m_channelWidth
 channel width More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::WifiInformationElement
template<typename IE , typename... Args>
static Buffer::Iterator DeserializeIfPresent (std::optional< IE > &optElem, Buffer::Iterator i, Args &&... args)
 Deserialize an entire IE (which may possibly be fragmented into multiple elements) that is optionally present. More...
 

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
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 118 of file vht-operation.cc.

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

+ 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 ( void  ) 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 102 of file vht-operation.cc.

References m_basicVhtMcsAndNssSet.

Referenced by ns3::operator<<(), and SerializeInformationField().

+ Here is the caller graph for this function:

◆ GetChannelCenterFrequencySegment0()

uint8_t ns3::VhtOperation::GetChannelCenterFrequencySegment0 ( void  ) 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 90 of file vht-operation.cc.

References m_channelCenterFrequencySegment0.

Referenced by ns3::operator<<(), and SerializeInformationField().

+ Here is the caller graph for this function:

◆ GetChannelCenterFrequencySegment1()

uint8_t ns3::VhtOperation::GetChannelCenterFrequencySegment1 ( void  ) 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 96 of file vht-operation.cc.

References m_channelCenterFrequencySegment1.

Referenced by ns3::operator<<(), and SerializeInformationField().

+ Here is the caller graph for this function:

◆ GetChannelWidth()

uint8_t ns3::VhtOperation::GetChannelWidth ( void  ) 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 84 of file vht-operation.cc.

References m_channelWidth.

Referenced by ns3::operator<<(), 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 40 of file vht-operation.cc.

◆ 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
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

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

References GetBasicVhtMcsAndNssSet(), GetChannelCenterFrequencySegment0(), GetChannelCenterFrequencySegment1(), GetChannelWidth(), and visualizer.core::start().

+ 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
basicVhtMcsAndNssSetthe Basic VHT-MCS and NSS field in the VHT Operation information element

Definition at line 78 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
channelCenterFrequencySegment0the Channel Center Frequency Segment 0 field in the VHT Operation information element

Definition at line 52 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
channelCenterFrequencySegment1the Channel Center Frequency Segment 1 field in the VHT Operation information element

Definition at line 58 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
channelWidththe Channel Width field in the VHT Operation information element

Definition at line 46 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
nssthe NSS
maxVhtMcsthe maximum supported VHT-MCS value corresponding to that NSS

Definition at line 64 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 113 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 109 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 110 of file vht-operation.h.

Referenced by GetChannelCenterFrequencySegment1(), and SetChannelCenterFrequencySegment1().

◆ m_channelWidth

uint8_t ns3::VhtOperation::m_channelWidth
private

channel width

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

Referenced by GetChannelWidth(), and SetChannelWidth().


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