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

The Supported Rates Information Element. More...

#include "supported-rates.h"

+ Inheritance diagram for ns3::SupportedRates:
+ Collaboration diagram for ns3::SupportedRates:

Public Member Functions

 SupportedRates ()
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID. More...
 
uint32_t GetRate (uint8_t i) const
 Return the rate (converted back to raw value) at the given index. More...
 
void Print (std::ostream &os) const override
 Generate human-readable form of IE. 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...
 
Buffer::Iterator DeserializeIfPresent (Buffer::Iterator i)
 Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present. 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== (const WifiInformationElement &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 

Protected 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...
 

Protected Attributes

std::vector< uint8_t > m_rates
 List of supported bit rates (divided by 500000) More...
 

Friends

struct AllSupportedRates
 

Detailed Description

The Supported Rates Information Element.

This class knows how to serialise and deserialise the Supported Rates Element that holds the first 8 (non-HT) supported rates.

The ExtendedSupportedRatesIE class deals with rates beyond the first 8.

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

Constructor & Destructor Documentation

◆ SupportedRates()

ns3::SupportedRates::SupportedRates ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::SupportedRates::DeserializeInformationField ( Buffer::Iterator  start,
uint16_t  length 
)
overrideprotectedvirtual

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

References m_rates, NS_ASSERT, and two-ray-to-three-gpp-ch-calibration::start.

◆ ElementId()

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

Get the wifi information element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Reimplemented in ns3::ExtendedSupportedRatesIE.

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

References IE_SUPPORTED_RATES.

◆ GetInformationFieldSize()

uint16_t ns3::SupportedRates::GetInformationFieldSize ( ) const
overrideprotectedvirtual

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

References m_rates.

◆ GetRate()

uint32_t ns3::SupportedRates::GetRate ( uint8_t  i) const

Return the rate (converted back to raw value) at the given index.

Parameters
ithe given index
Returns
the rate in bps

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

References m_rates.

Referenced by Print().

+ Here is the caller graph for this function:

◆ Print()

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

Generate human-readable form of IE.

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

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

References GetRate(), and m_rates.

+ Here is the call graph for this function:

◆ SerializeInformationField()

void ns3::SupportedRates::SerializeInformationField ( Buffer::Iterator  start) const
overrideprotectedvirtual

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

References m_rates, and two-ray-to-three-gpp-ch-calibration::start.

Friends And Related Function Documentation

◆ AllSupportedRates

friend struct AllSupportedRates
friend

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

Member Data Documentation

◆ m_rates


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