Capability information. More...

#include "capability-information.h"

Collaboration diagram for ns3::CapabilityInformation:

Public Member Functions
	CapabilityInformation ()

Buffer::Iterator	Deserialize (Buffer::Iterator start)
	Deserialize capability information from the given buffer.

uint32_t	GetSerializedSize () const
	Return the serialized size of capability information.

bool	IsCfPollable () const
	Check if the CF-Pollable bit in the capability information field is set to 1.

bool	IsCriticalUpdate () const
	Check if Critical Update bit is set to 1.

bool	IsEss () const
	Check if the Extended Service Set (ESS) bit in the capability information field is set to 1.

bool	IsIbss () const
	Check if the Independent BSS (IBSS) bit in the capability information field is set to 1.

bool	IsShortPreamble () const
	Check if the short preamble bit in the capability information field is set to 1.

bool	IsShortSlotTime () const
	Check if the short slot time in the capability information field is set to 1.

Buffer::Iterator	Serialize (Buffer::Iterator start) const
	Serialize capability information to the given buffer.

void	SetCfPollable ()
	Set the CF-Pollable bit in the capability information field.

void	SetCriticalUpdate (bool flag)
	Set Critical Update flag (see IEEE 802.11be D5.0 9.4.1.4)

void	SetEss ()
	Set the Extended Service Set (ESS) bit in the capability information field.

void	SetIbss ()
	Set the Independent BSS (IBSS) bit in the capability information field.

void	SetShortPreamble (bool shortPreamble)
	Set the short preamble bit in the capability information field.

void	SetShortSlotTime (bool shortSlotTime)
	Set the short slot time bit in the capability information field.

Private Member Functions
void	Clear (uint8_t n)
	Set bit n to 0.

bool	Is (uint8_t n) const
	Check if bit n is set to 1.

void	Set (uint8_t n)
	Set bit n to 1.

Private Attributes
uint16_t	m_capability
	capability

Detailed Description

Capability information.

Definition at line 22 of file capability-information.h.

Constructor & Destructor Documentation

◆ CapabilityInformation()

ns3::CapabilityInformation::CapabilityInformation ( )

Definition at line 14 of file capability-information.cc.

References m_capability.

Member Function Documentation

◆ Clear()

void ns3::CapabilityInformation::Clear ( uint8_t n )

private

Set bit n to 0.

Parameters

n	the bit position

Definition at line 110 of file capability-information.cc.

References m_capability.

Referenced by SetEss(), and SetIbss().

Here is the caller graph for this function:

◆ Deserialize()

Buffer::Iterator ns3::CapabilityInformation::Deserialize ( Buffer::Iterator start )

Deserialize capability information from the given buffer.

Parameters

start an iterator to a buffer

Returns: an iterator to a buffer after capability information was deserialized

Definition at line 137 of file capability-information.cc.

References m_capability.

Referenced by BasicMultiLinkElementTest::DoRun().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::CapabilityInformation::GetSerializedSize ( ) const

Return the serialized size of capability information.

Returns: the serialized size

Definition at line 124 of file capability-information.cc.

◆ Is()

bool ns3::CapabilityInformation::Is ( uint8_t n ) const

private

Check if bit n is set to 1.

Parameters

n	the bit position

Returns: true if bit n is set to 1, false otherwise

Definition at line 117 of file capability-information.cc.

References m_capability.

Referenced by IsCfPollable(), IsCriticalUpdate(), IsEss(), IsIbss(), IsShortPreamble(), and IsShortSlotTime().

Here is the caller graph for this function:

◆ IsCfPollable()

bool ns3::CapabilityInformation::IsCfPollable ( ) const

Check if the CF-Pollable bit in the capability information field is set to 1.

Returns: CF-Pollable bit in the capability information field is set to 1

Definition at line 91 of file capability-information.cc.

References Is().

Here is the call graph for this function:

◆ IsCriticalUpdate()

bool ns3::CapabilityInformation::IsCriticalUpdate ( ) const

Check if Critical Update bit is set to 1.

Returns: true if set to 1, false otherwise

Definition at line 97 of file capability-information.cc.

References Is().

Here is the call graph for this function:

◆ IsEss()

bool ns3::CapabilityInformation::IsEss ( ) const

Check if the Extended Service Set (ESS) bit in the capability information field is set to 1.

Returns: ESS bit in the capability information field is set to 1

Definition at line 67 of file capability-information.cc.

References Is().

Here is the call graph for this function:

◆ IsIbss()

bool ns3::CapabilityInformation::IsIbss ( ) const

Check if the Independent BSS (IBSS) bit in the capability information field is set to 1.

Returns: IBSS bit in the capability information field is set to 1

Definition at line 73 of file capability-information.cc.

References Is().

Here is the call graph for this function:

◆ IsShortPreamble()

bool ns3::CapabilityInformation::IsShortPreamble ( ) const

Check if the short preamble bit in the capability information field is set to 1.

Returns: short preamble bit in the capability information field is set to 1

Definition at line 79 of file capability-information.cc.

References Is().

Referenced by ns3::ApWifiMac::ReceiveAssocRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsShortSlotTime()

bool ns3::CapabilityInformation::IsShortSlotTime ( ) const

Check if the short slot time in the capability information field is set to 1.

Returns: short slot time bit in the capability information field is set to 1

Definition at line 85 of file capability-information.cc.

References Is().

Referenced by ns3::ApWifiMac::ReceiveAssocRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize()

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

Serialize capability information to the given buffer.

Parameters

start an iterator to a buffer

Returns: an iterator to a buffer after capability information was serialized

Definition at line 130 of file capability-information.cc.

References m_capability.

◆ Set()

void ns3::CapabilityInformation::Set ( uint8_t n )

private

Set bit n to 1.

Parameters

n	the bit position

Definition at line 103 of file capability-information.cc.

References m_capability.

Referenced by SetCfPollable(), SetCriticalUpdate(), SetEss(), SetIbss(), SetShortPreamble(), and SetShortSlotTime().

Here is the caller graph for this function:

◆ SetCfPollable()

void ns3::CapabilityInformation::SetCfPollable ( )

Set the CF-Pollable bit in the capability information field.

Definition at line 52 of file capability-information.cc.

References Set().

Here is the call graph for this function:

◆ SetCriticalUpdate()

void ns3::CapabilityInformation::SetCriticalUpdate ( bool flag )

Set Critical Update flag (see IEEE 802.11be D5.0 9.4.1.4)

Parameters

flag	critical update bit

Definition at line 58 of file capability-information.cc.

References Set().

Here is the call graph for this function:

◆ SetEss()

void ns3::CapabilityInformation::SetEss ( )

Set the Extended Service Set (ESS) bit in the capability information field.

Definition at line 20 of file capability-information.cc.

References Clear(), and Set().

Referenced by ns3::ApWifiMac::GetCapabilities().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetIbss()

void ns3::CapabilityInformation::SetIbss ( )

Set the Independent BSS (IBSS) bit in the capability information field.

Definition at line 27 of file capability-information.cc.

References Clear(), and Set().

Here is the call graph for this function:

◆ SetShortPreamble()

void ns3::CapabilityInformation::SetShortPreamble ( bool shortPreamble )

Set the short preamble bit in the capability information field.

Parameters

shortPreamble the short preamble bit

Definition at line 34 of file capability-information.cc.

References Set().

Referenced by BasicMultiLinkElementTest::DoRun(), ns3::ApWifiMac::GetCapabilities(), and ns3::StaWifiMac::GetCapabilities().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetShortSlotTime()

void ns3::CapabilityInformation::SetShortSlotTime ( bool shortSlotTime )

Set the short slot time bit in the capability information field.

Parameters

shortSlotTime the short preamble bit

Definition at line 43 of file capability-information.cc.

References Set().

Referenced by ns3::ApWifiMac::GetCapabilities(), and ns3::StaWifiMac::GetCapabilities().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_capability

uint16_t ns3::CapabilityInformation::m_capability

private

capability

Definition at line 160 of file capability-information.h.

Referenced by CapabilityInformation(), Clear(), Deserialize(), Is(), Serialize(), and Set().

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

src/wifi/model/capability-information.h
src/wifi/model/capability-information.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CapabilityInformation()

Member Function Documentation

◆ Clear()

◆ Deserialize()

◆ GetSerializedSize()

◆ Is()

◆ IsCfPollable()

◆ IsCriticalUpdate()

◆ IsEss()

◆ IsIbss()

◆ IsShortPreamble()

◆ IsShortSlotTime()

◆ Serialize()

◆ Set()

◆ SetCfPollable()

◆ SetCriticalUpdate()

◆ SetEss()

◆ SetIbss()

◆ SetShortPreamble()

◆ SetShortSlotTime()

Member Data Documentation

◆ m_capability