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

The Extended Supported Rates Information ElementThis class knows how to serialise and deserialise the Extended Supported Rates Element that holds (non-HT) rates beyond the 8 that the original Supported Rates element can carry. More...

#include "supported-rates.h"

+ Inheritance diagram for ns3::ExtendedSupportedRatesIE:
+ Collaboration diagram for ns3::ExtendedSupportedRatesIE:

Public Member Functions

 ExtendedSupportedRatesIE ()
 
 ExtendedSupportedRatesIE (SupportedRates *rates)
 Create an extended supported rates information element from the given rates. More...
 
uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)
 Deserialize information field. More...
 
WifiInformationElementId ElementId () const
 Get element ID. More...
 
uint8_t GetInformationFieldSize () const
 Get information field size. More...
 
uint16_t GetSerializedSize () const
 Return the serialized size of this supported rates information element. More...
 
Buffer::Iterator Serialize (Buffer::Iterator start) const
 This information element is a bit special in that it is only included if there are more than 8 rates. More...
 
void SerializeInformationField (Buffer::Iterator start) const
 Serialize information field. More...
 
void SetSupportedRates (SupportedRates *rates)
 Set supported rates. More...
 
- Public Member Functions inherited from ns3::WifiInformationElement
virtual ~WifiInformationElement ()
 
Buffer::Iterator Deserialize (Buffer::Iterator i)
 Deserialize entire IE, which must be present. More...
 
Buffer::Iterator DeserializeIfPresent (Buffer::Iterator i)
 Deserialize entire IE if it is present. More...
 
virtual WifiInformationElementId ElementIdExt () const
 
uint16_t GetSerializedSize () const
 Get the size of the serialized IE including Element ID and length fields. 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 Attributes

SupportedRatesm_supportedRates
 This member points to the SupportedRates object that contains the actual rate details. More...
 

Detailed Description

The Extended Supported Rates Information Element

This class knows how to serialise and deserialise the Extended Supported Rates Element that holds (non-HT) rates beyond the 8 that the original Supported Rates element can carry.

The SupportedRates class still records all the rates, and an instance of ExtendedSupportedRatesIE lies within SupportedRates.

Definition at line 42 of file supported-rates.h.

Constructor & Destructor Documentation

◆ ExtendedSupportedRatesIE() [1/2]

ns3::ExtendedSupportedRatesIE::ExtendedSupportedRatesIE ( )

Definition at line 207 of file supported-rates.cc.

◆ ExtendedSupportedRatesIE() [2/2]

ns3::ExtendedSupportedRatesIE::ExtendedSupportedRatesIE ( SupportedRates rates)

Create an extended supported rates information element from the given rates.

Parameters
rates

Definition at line 211 of file supported-rates.cc.

References m_supportedRates.

Member Function Documentation

◆ DeserializeInformationField()

uint8_t ns3::ExtendedSupportedRatesIE::DeserializeInformationField ( Buffer::Iterator  start,
uint8_t  length 
)
virtual

Deserialize information field.

Parameters
startthe iterator
lengththe field length (bytes)
Returns
length of the information field deserialized (bytes)

Implements ns3::WifiInformationElement.

Definition at line 287 of file supported-rates.cc.

References ns3::SupportedRates::m_nRates, ns3::SupportedRates::m_rates, m_supportedRates, ns3::SupportedRates::MAX_SUPPORTED_RATES, NS_ASSERT, and visualizer.core::start().

+ Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::ExtendedSupportedRatesIE::ElementId ( ) const
virtual

Get element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 217 of file supported-rates.cc.

References IE_EXTENDED_SUPPORTED_RATES.

◆ GetInformationFieldSize()

uint8_t ns3::ExtendedSupportedRatesIE::GetInformationFieldSize ( void  ) const
virtual

Get information field size.

Returns
the information field size

Implements ns3::WifiInformationElement.

Definition at line 229 of file supported-rates.cc.

References ns3::SupportedRates::m_nRates, m_supportedRates, and NS_ASSERT.

◆ GetSerializedSize()

uint16_t ns3::ExtendedSupportedRatesIE::GetSerializedSize ( void  ) const

Return the serialized size of this supported rates information element.

Returns
the serialized size of this supported rates information element

Definition at line 272 of file supported-rates.cc.

References ns3::WifiInformationElement::GetSerializedSize(), ns3::SupportedRates::m_nRates, and m_supportedRates.

Referenced by ns3::dot11s::PeerLinkOpenStart::GetSerializedSize(), ns3::MgtAssocRequestHeader::GetSerializedSize(), ns3::dot11s::PeerLinkConfirmStart::GetSerializedSize(), ns3::MgtReassocRequestHeader::GetSerializedSize(), ns3::MgtAssocResponseHeader::GetSerializedSize(), ns3::MgtProbeRequestHeader::GetSerializedSize(), and ns3::MgtProbeResponseHeader::GetSerializedSize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Serialize()

Buffer::Iterator ns3::ExtendedSupportedRatesIE::Serialize ( Buffer::Iterator  start) const

This information element is a bit special in that it is only included if there are more than 8 rates.

To support this we override the Serialize and GetSerializedSize methods of WifiInformationElement.

Parameters
start
Returns
an iterator

Definition at line 258 of file supported-rates.cc.

References ns3::SupportedRates::m_nRates, m_supportedRates, ns3::WifiInformationElement::Serialize(), and visualizer.core::start().

Referenced by ns3::dot11s::PeerLinkOpenStart::Serialize(), ns3::MgtAssocRequestHeader::Serialize(), ns3::dot11s::PeerLinkConfirmStart::Serialize(), ns3::MgtReassocRequestHeader::Serialize(), ns3::MgtAssocResponseHeader::Serialize(), ns3::MgtProbeRequestHeader::Serialize(), and ns3::MgtProbeResponseHeader::Serialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SerializeInformationField()

void ns3::ExtendedSupportedRatesIE::SerializeInformationField ( Buffer::Iterator  start) const
virtual

Serialize information field.

Parameters
startthe iterator

Implements ns3::WifiInformationElement.

Definition at line 244 of file supported-rates.cc.

References ns3::SupportedRates::m_nRates, ns3::SupportedRates::m_rates, m_supportedRates, NS_ASSERT, and visualizer.core::start().

+ Here is the call graph for this function:

◆ SetSupportedRates()

void ns3::ExtendedSupportedRatesIE::SetSupportedRates ( SupportedRates rates)

Set supported rates.

Parameters
ratesthe supported rates

Definition at line 223 of file supported-rates.cc.

References m_supportedRates.

Referenced by ns3::SupportedRates::operator=(), and ns3::SupportedRates::SupportedRates().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_supportedRates

SupportedRates* ns3::ExtendedSupportedRatesIE::m_supportedRates
private

This member points to the SupportedRates object that contains the actual rate details.

This class is a friend of that, so we have access to all the private data we need.

Definition at line 114 of file supported-rates.h.

Referenced by DeserializeInformationField(), ExtendedSupportedRatesIE(), GetInformationFieldSize(), GetSerializedSize(), Serialize(), SerializeInformationField(), and SetSupportedRates().


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