TID-to-Link Mapping Information Element. More...

#include "tid-to-link-mapping-element.h"

Inheritance diagram for ns3::TidToLinkMapping:

Collaboration diagram for ns3::TidToLinkMapping:

Classes
struct	Control
	TID-to-Link Mapping Control subfield IEEE 802.11be D3.1 Figure 9-1002ap. More...

Public Member Functions
WifiInformationElementId	ElementId () const override
	Get the wifi information element ID.

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

std::optional< Time >	GetExpectedDuration () const

std::set< uint8_t >	GetLinkMappingOfTid (uint8_t tid) const
	Get the Link Mapping field of the given TID.

std::optional< Time >	GetMappingSwitchTime () const

void	SetExpectedDuration (Time expectedDuration)
	Set the Expected Duration field.

void	SetLinkMappingOfTid (uint8_t tid, std::set< uint8_t > linkIds)
	Set the Link Mapping field of the given TID such that the given TID is mapped to the links associated with the given link IDs.

void	SetMappingSwitchTime (Time mappingSwitchTime)
	Set the Mapping Switch Time field.

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	ElementId () const =0
	Get the wifi information element ID.

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.

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

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.

Public Attributes
TidToLinkMapping::Control	m_control
	TID-to-link Mapping Control.

std::map< uint8_t, uint16_t >	m_linkMapping
	TID-indexed Link Mapping.

Private 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)

Private Attributes
std::optional< uint32_t >	m_expectedDuration
	Expected Duration.

std::optional< uint16_t >	m_mappingSwitchTime
	Mapping Switch Time.

Detailed Description

TID-to-Link Mapping Information Element.

This class serializes and deserializes the TID-to-Link Mapping element IEEE 802.11be D3.1 9.4.2.314

Definition at line 53 of file tid-to-link-mapping-element.h.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::TidToLinkMapping::DeserializeInformationField	(	Buffer::Iterator	start,
		uint16_t	length
	)

overrideprivatevirtual

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 248 of file tid-to-link-mapping-element.cc.

References ns3::TidToLinkMapping::Control::defaultMapping, ns3::TidToLinkMapping::Control::Deserialize(), ns3::TidToLinkMapping::Control::expectedDurationPresent, ns3::TidToLinkMapping::Control::linkMappingSize, m_control, m_expectedDuration, m_linkMapping, m_mappingSwitchTime, ns3::TidToLinkMapping::Control::mappingSwitchTimePresent, NS_ABORT_MSG_IF, NS_ASSERT_MSG, and ns3::TidToLinkMapping::Control::presenceBitmap.

Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::TidToLinkMapping::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 84 of file tid-to-link-mapping-element.cc.

References IE_EXTENSION.

◆ ElementIdExt()

WifiInformationElementId ns3::TidToLinkMapping::ElementIdExt ( ) const

overridevirtual

Get the wifi information element ID extension.

Returns: the wifi information element ID extension

Reimplemented from ns3::WifiInformationElement.

Definition at line 90 of file tid-to-link-mapping-element.cc.

References IE_EXT_TID_TO_LINK_MAPPING_ELEMENT.

◆ GetExpectedDuration()

std::optional< Time > ns3::TidToLinkMapping::GetExpectedDuration ( ) const

Returns: the value of the Expected Duration field, if present.

Definition at line 138 of file tid-to-link-mapping-element.cc.

References ns3::TidToLinkMapping::Control::expectedDurationPresent, m_control, m_expectedDuration, and ns3::MicroSeconds().

Referenced by TidToLinkMappingElementTest::DoSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInformationFieldSize()

uint16_t ns3::TidToLinkMapping::GetInformationFieldSize ( ) const

overrideprivatevirtual

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 195 of file tid-to-link-mapping-element.cc.

References ns3::TidToLinkMapping::Control::defaultMapping, ns3::TidToLinkMapping::Control::expectedDurationPresent, ns3::TidToLinkMapping::Control::GetSubfieldSize(), ns3::TidToLinkMapping::Control::linkMappingSize, m_control, m_linkMapping, ns3::TidToLinkMapping::Control::mappingSwitchTimePresent, NS_ASSERT_MSG, and ns3::WIFI_IE_ELEMENT_ID_EXT_SIZE.

Here is the call graph for this function:

◆ GetLinkMappingOfTid()

std::set< uint8_t > ns3::TidToLinkMapping::GetLinkMappingOfTid ( uint8_t tid ) const

Get the Link Mapping field of the given TID.

Parameters

tid	the given TID

Returns: the IDs of the links which the given TID is mapped to

Definition at line 172 of file tid-to-link-mapping-element.cc.

References m_linkMapping, and NS_ABORT_MSG_IF.

Referenced by TidToLinkMappingElementTest::DoSetup(), and ns3::ApWifiMac::ReceiveAssocRequest().

Here is the caller graph for this function:

◆ GetMappingSwitchTime()

std::optional< Time > ns3::TidToLinkMapping::GetMappingSwitchTime ( ) const

Returns: the value of the Mapping Switch Time field, if present.

Definition at line 110 of file tid-to-link-mapping-element.cc.

References ns3::BIT_63_TO_26_MASK, ns3::Time::GetMicroSeconds(), m_control, m_mappingSwitchTime, ns3::TidToLinkMapping::Control::mappingSwitchTimePresent, ns3::MicroSeconds(), and ns3::Simulator::Now().

Referenced by TidToLinkMappingElementTest::DoSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SerializeInformationField()

void ns3::TidToLinkMapping::SerializeInformationField ( Buffer::Iterator start ) const

overrideprivatevirtual

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 216 of file tid-to-link-mapping-element.cc.

References ns3::TidToLinkMapping::Control::defaultMapping, ns3::TidToLinkMapping::Control::expectedDurationPresent, ns3::TidToLinkMapping::Control::linkMappingSize, m_control, m_expectedDuration, m_linkMapping, m_mappingSwitchTime, ns3::TidToLinkMapping::Control::mappingSwitchTimePresent, NS_ASSERT_MSG, and ns3::TidToLinkMapping::Control::Serialize().

Here is the call graph for this function:

◆ SetExpectedDuration()

void ns3::TidToLinkMapping::SetExpectedDuration ( Time expectedDuration )

Set the Expected Duration field.

Parameters

expectedDuration the value for the Expected Duration field (rounded to a multiple of a TU)

Definition at line 130 of file tid-to-link-mapping-element.cc.

References ns3::TidToLinkMapping::Control::expectedDurationPresent, ns3::Time::GetMicroSeconds(), m_control, and m_expectedDuration.

Referenced by TidToLinkMappingElementTest::DoSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLinkMappingOfTid()

void ns3::TidToLinkMapping::SetLinkMappingOfTid	(	uint8_t	tid,
		std::set< uint8_t >	linkIds
	)

Set the Link Mapping field of the given TID such that the given TID is mapped to the links associated with the given link IDs.

Parameters

tid	the given TID
linkIds	the IDs of the links which the given TID is mapped to

Definition at line 149 of file tid-to-link-mapping-element.cc.

References ns3::TidToLinkMapping::Control::defaultMapping, ns3::TidToLinkMapping::Control::linkMappingSize, m_control, m_linkMapping, NS_ABORT_MSG_IF, and ns3::TidToLinkMapping::Control::presenceBitmap.

Referenced by TidToLinkMappingElementTest::DoSetup().

Here is the caller graph for this function:

◆ SetMappingSwitchTime()

void ns3::TidToLinkMapping::SetMappingSwitchTime ( Time mappingSwitchTime )

Set the Mapping Switch Time field.

Parameters

mappingSwitchTime the time when the new mapping is established (rounded to a multiple of a TU)

Definition at line 96 of file tid-to-link-mapping-element.cc.

References ns3::Time::GetMicroSeconds(), m_control, m_mappingSwitchTime, ns3::TidToLinkMapping::Control::mappingSwitchTimePresent, ns3::Simulator::Now(), and NS_ABORT_IF.

Referenced by TidToLinkMappingElementTest::DoSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_control

TidToLinkMapping::Control ns3::TidToLinkMapping::m_control

TID-to-link Mapping Control.

Definition at line 136 of file tid-to-link-mapping-element.h.

Referenced by DeserializeInformationField(), TidToLinkMappingElementTest::DoSetup(), GetExpectedDuration(), GetInformationFieldSize(), GetMappingSwitchTime(), ns3::ApWifiMac::ReceiveAssocRequest(), SerializeInformationField(), SetExpectedDuration(), SetLinkMappingOfTid(), and SetMappingSwitchTime().

◆ m_expectedDuration

std::optional<uint32_t> ns3::TidToLinkMapping::m_expectedDuration

private

Expected Duration.

Definition at line 141 of file tid-to-link-mapping-element.h.

Referenced by DeserializeInformationField(), GetExpectedDuration(), SerializeInformationField(), and SetExpectedDuration().

◆ m_linkMapping

std::map<uint8_t, uint16_t> ns3::TidToLinkMapping::m_linkMapping

TID-indexed Link Mapping.

Definition at line 137 of file tid-to-link-mapping-element.h.

Referenced by DeserializeInformationField(), GetInformationFieldSize(), GetLinkMappingOfTid(), SerializeInformationField(), and SetLinkMappingOfTid().

◆ m_mappingSwitchTime

std::optional<uint16_t> ns3::TidToLinkMapping::m_mappingSwitchTime

private

Mapping Switch Time.

Definition at line 140 of file tid-to-link-mapping-element.h.

Referenced by DeserializeInformationField(), GetMappingSwitchTime(), SerializeInformationField(), and SetMappingSwitchTime().

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

src/wifi/model/eht/tid-to-link-mapping-element.h
src/wifi/model/eht/tid-to-link-mapping-element.cc

Classes

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ ElementIdExt()

◆ GetExpectedDuration()

◆ GetInformationFieldSize()

◆ GetLinkMappingOfTid()

◆ GetMappingSwitchTime()

◆ SerializeInformationField()

◆ SetExpectedDuration()

◆ SetLinkMappingOfTid()

◆ SetMappingSwitchTime()

Member Data Documentation

◆ m_control

◆ m_expectedDuration

◆ m_linkMapping

◆ m_mappingSwitchTime