A tag to be attached to a response to a multi-user UL frame, that carries the SNR values with which the individual frames have been received. More...

#include "mu-snr-tag.h"

Inheritance diagram for ns3::MuSnrTag:

Collaboration diagram for ns3::MuSnrTag:

Public Member Functions
	MuSnrTag ()
	Create an empty MuSnrTag.

void	Deserialize (TagBuffer i) override

double	Get (uint16_t staId) const
	Return the SNR value for the given sender.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint32_t	GetSerializedSize () const override

bool	IsPresent (uint16_t staId) const
	Return true if the SNR value for the given STA-ID is present.

void	Print (std::ostream &os) const override

void	Reset ()
	Reset the content of the tag.

void	Serialize (TagBuffer i) const override

void	Set (uint16_t staId, double snr)
	Set the SNR for the given sender to the given value.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Tag
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
std::map< uint16_t, double >	m_snrMap
	Map containing (STA-ID, SNR) pairs.

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

A tag to be attached to a response to a multi-user UL frame, that carries the SNR values with which the individual frames have been received.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wifi

Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 25 of file mu-snr-tag.h.

Constructor & Destructor Documentation

◆ MuSnrTag()

ns3::MuSnrTag::MuSnrTag ( )

Create an empty MuSnrTag.

Definition at line 30 of file mu-snr-tag.cc.

Member Function Documentation

◆ Deserialize()

void ns3::MuSnrTag::Deserialize ( TagBuffer i )

overridevirtual

Parameters

i	the buffer to read data from.

Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implements ns3::Tag.

Definition at line 78 of file mu-snr-tag.cc.

References m_snrMap, ns3::TagBuffer::ReadDouble(), ns3::TagBuffer::ReadU16(), and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

◆ Get()

double ns3::MuSnrTag::Get ( uint16_t staId ) const

Return the SNR value for the given sender.

Parameters

staId the STA-ID of the given sender

Returns: the SNR value in linear scale

Definition at line 53 of file mu-snr-tag.cc.

References IsPresent(), m_snrMap, and NS_ASSERT.

Referenced by ns3::HeFrameExchangeManager::ReceiveMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::MuSnrTag::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 25 of file mu-snr-tag.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::MuSnrTag::GetSerializedSize ( ) const

overridevirtual

Returns: the number of bytes required to serialize the data of the tag.

This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 60 of file mu-snr-tag.cc.

References m_snrMap.

◆ GetTypeId()

TypeId ns3::MuSnrTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 17 of file mu-snr-tag.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsPresent()

bool ns3::MuSnrTag::IsPresent ( uint16_t staId ) const

Return true if the SNR value for the given STA-ID is present.

Parameters

staId the STA-ID

Returns: true if the SNR value for the given STA-ID is present

Definition at line 47 of file mu-snr-tag.cc.

References m_snrMap.

Referenced by Get().

Here is the caller graph for this function:

◆ Print()

void ns3::MuSnrTag::Print ( std::ostream & os ) const

overridevirtual

Parameters

os	the stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

Definition at line 90 of file mu-snr-tag.cc.

References m_snrMap.

◆ Reset()

void ns3::MuSnrTag::Reset ( )

Reset the content of the tag.

Definition at line 35 of file mu-snr-tag.cc.

References m_snrMap.

◆ Serialize()

void ns3::MuSnrTag::Serialize ( TagBuffer i ) const

overridevirtual

Parameters

i	the buffer to write data into.

Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implements ns3::Tag.

Definition at line 66 of file mu-snr-tag.cc.

References m_snrMap, ns3::TagBuffer::WriteDouble(), ns3::TagBuffer::WriteU16(), and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

◆ Set()

void ns3::MuSnrTag::Set	(	uint16_t	staId,
		double	snr )

Set the SNR for the given sender to the given value.

Parameters

staId	the STA-ID of the given sender
snr	the value of the SNR to set in linear scale

Definition at line 41 of file mu-snr-tag.cc.

References m_snrMap.

Member Data Documentation

◆ m_snrMap

std::map<uint16_t, double> ns3::MuSnrTag::m_snrMap

private

Map containing (STA-ID, SNR) pairs.

Definition at line 72 of file mu-snr-tag.h.

Referenced by Deserialize(), Get(), GetSerializedSize(), IsPresent(), Print(), Reset(), Serialize(), and Set().

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

src/wifi/model/he/mu-snr-tag.h
src/wifi/model/he/mu-snr-tag.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MuSnrTag()

Member Function Documentation

◆ Deserialize()

◆ Get()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ IsPresent()

◆ Print()

◆ Reset()

◆ Serialize()

◆ Set()

Member Data Documentation

◆ m_snrMap