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.

uint32_t	GetRate (uint8_t i) const
	Return the rate (converted back to raw value) at the given index.

void	Print (std::ostream &os) const override
	Generate human-readable form of IE.

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.

virtual WifiInformationElementId	ElementIdExt () const
	Get the wifi information element ID extension.

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.

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)

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)

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

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

Constructor & Destructor Documentation

◆ SupportedRates()

ns3::SupportedRates::SupportedRates ( )

Definition at line 25 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

start	an iterator which points to where the information should be written.
length	the expected number of bytes to read

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

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

References m_rates, and NS_ASSERT.

◆ ElementId()

WifiInformationElementId ns3::SupportedRates::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 196 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 202 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

i	the given index

Returns: the rate in bps

Definition at line 190 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

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 31 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

start an iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

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

References m_rates.

Friends And Related Symbol Documentation

◆ AllSupportedRates

friend struct AllSupportedRates

friend

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

Member Data Documentation

◆ m_rates

std::vector<uint8_t> ns3::SupportedRates::m_rates

protected

List of supported bit rates (divided by 500000)

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

Referenced by ns3::AllSupportedRates::AddBssMembershipSelectorRate(), ns3::AllSupportedRates::AddSupportedRate(), DeserializeInformationField(), GetInformationFieldSize(), ns3::AllSupportedRates::GetNRates(), GetRate(), ns3::AllSupportedRates::IsBasicRate(), ns3::AllSupportedRates::IsSupportedRate(), Print(), SerializeInformationField(), and ns3::AllSupportedRates::SetBasicRate().

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

src/wifi/model/supported-rates.h
src/wifi/model/supported-rates.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SupportedRates()

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetInformationFieldSize()

◆ GetRate()

◆ Print()

◆ SerializeInformationField()

Friends And Related Symbol Documentation

◆ AllSupportedRates

Member Data Documentation

◆ m_rates