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

The Extended Supported Rates Information Element. 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) override
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID. More...
 
uint8_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...
 
uint16_t GetSerializedSize () const override
 Get the size of the serialized IE including Element ID and length fields. More...
 
Buffer::Iterator Serialize (Buffer::Iterator start) const override
 Serialize entire IE including Element ID and length fields. 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...
 
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 uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)=0
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) 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...
 
virtual uint8_t GetInformationFieldSize () const =0
 Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...
 
virtual 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...
 
virtual Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
virtual void SerializeInformationField (Buffer::Iterator start) const =0
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets) 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 210 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
ratesthe extended supported rates

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

References m_supportedRates.

Member Function Documentation

◆ DeserializeInformationField()

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

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.
length
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 290 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
overridevirtual

Get the wifi information element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

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

References IE_EXTENDED_SUPPORTED_RATES.

◆ GetInformationFieldSize()

uint8_t ns3::ExtendedSupportedRatesIE::GetInformationFieldSize ( ) const
overridevirtual

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)

Returns
the length of serialized information

Implements ns3::WifiInformationElement.

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

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

◆ GetSerializedSize()

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

◆ Serialize()

Buffer::Iterator ns3::ExtendedSupportedRatesIE::Serialize ( Buffer::Iterator  i) const
overridevirtual

Serialize entire IE including Element ID and length fields.

Parameters
ian iterator which points to where the IE should be written.
Returns
an iterator

Reimplemented from ns3::WifiInformationElement.

Definition at line 261 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::dot11s::PeerLinkConfirmStart::Serialize(), ns3::MgtReassocRequestHeader::Serialize(), ns3::MgtAssocResponseHeader::Serialize(), ns3::MgtProbeRequestHeader::Serialize(), ns3::MgtProbeResponseHeader::Serialize(), and ns3::MgtAssocRequestHeader::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
overridevirtual

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 247 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 226 of file supported-rates.cc.

References m_supportedRates.

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

+ 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 81 of file supported-rates.h.

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


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