A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SupportedRates Class Reference

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

#include <supported-rates.h>

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

Public Member Functions

 SupportedRates ()
 
void AddSupportedRate (uint32_t bs)
 Add the given rate to the supported rates. More...
 
uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
WifiInformationElementId ElementId () const
 Own unique Element ID. More...
 
uint8_t GetInformationFieldSize () const
 Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...
 
uint8_t GetNRates (void) const
 Return the number of supported rates. More...
 
uint32_t GetRate (uint8_t i) const
 Return the rate at the given index. More...
 
bool IsBasicRate (uint32_t bs) const
 Check if the given rate is a basic rate. More...
 
bool IsSupportedRate (uint32_t bs) const
 Check if the given rate is supported. More...
 
void SerializeInformationField (Buffer::Iterator start) const
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
void SetBasicRate (uint32_t bs)
 Set the given rate to basic 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...
 
uint16_t GetSerializedSize () const
 Get the size of the serialized IE including Element ID and length fields. More...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
virtual void Print (std::ostream &os) const
 In addition, a subclass may optionally override the following... More...
 
virtual bool operator< (WifiInformationElement const &a) const
 Compare information elements using Element ID. More...
 
virtual bool operator== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
 SimpleRefCount ()
 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. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Public Attributes

ExtendedSupportedRatesIE extended
 

Private Attributes

uint8_t m_nRates
 Number of supported rates. More...
 
uint8_t m_rates [MAX_SUPPORTED_RATES]
 List of supported bitrate (divided by 500000) More...
 

Friends

class ExtendedSupportedRatesIE
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
static void Cleanup (void)
 Noop. More...
 

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 (of which an instance exists in objects of this class) deals with rates beyond the first 8.

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

Constructor & Destructor Documentation

ns3::SupportedRates::SupportedRates ( )

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

Member Function Documentation

void ns3::SupportedRates::AddSupportedRate ( uint32_t  bs)

Add the given rate to the supported rates.

Parameters
bsthe rate to be added

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

References IsSupportedRate(), m_nRates, m_rates, MAX_SUPPORTED_RATES, NS_ASSERT, and NS_LOG_DEBUG.

Referenced by ns3::MeshWifiInterfaceMac::GetSupportedRates(), ns3::StaWifiMac::GetSupportedRates(), ns3::ApWifiMac::GetSupportedRates(), and SetBasicRate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References m_nRates, m_rates, NS_ASSERT, and ns3::Buffer::Iterator::Read().

+ Here is the call graph for this function:

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

Own unique Element ID.

Implements ns3::WifiInformationElement.

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

References IE_SUPPORTED_RATES.

uint8_t ns3::SupportedRates::GetInformationFieldSize ( ) const
virtual

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

References m_nRates.

uint8_t ns3::SupportedRates::GetNRates ( void  ) const

Return the number of supported rates.

Returns
the number of supported rates

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

References m_nRates.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

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

Return the rate at the given index.

Parameters
ithe given index
Returns
the rate

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

References m_rates.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

bool ns3::SupportedRates::IsBasicRate ( uint32_t  bs) const

Check if the given rate is a basic rate.

Parameters
bsthe rate to be checked
Returns
true if the rate is a basic rate, false otherwise

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

References m_nRates, and m_rates.

Referenced by ns3::operator<<(), ns3::StaWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

+ Here is the caller graph for this function:

bool ns3::SupportedRates::IsSupportedRate ( uint32_t  bs) const

Check if the given rate is supported.

Parameters
bsthe rate to be checked
Returns
true if the rate is supported, false otherwise

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

References m_nRates, and m_rates.

Referenced by AddSupportedRate(), ns3::MeshWifiInterfaceMac::CheckSupportedRates(), ns3::ApWifiMac::Receive(), ns3::StaWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

+ Here is the caller graph for this function:

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

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

References m_nRates, m_rates, and ns3::Buffer::Iterator::Write().

+ Here is the call graph for this function:

void ns3::SupportedRates::SetBasicRate ( uint32_t  bs)

Set the given rate to basic rates.

Parameters
bsthe rate to be set

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

References AddSupportedRate(), m_nRates, m_rates, and NS_LOG_DEBUG.

Referenced by ns3::MeshWifiInterfaceMac::GetSupportedRates(), ns3::StaWifiMac::GetSupportedRates(), and ns3::ApWifiMac::GetSupportedRates().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class ExtendedSupportedRatesIE
friend

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

Member Data Documentation


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