A Discrete-Event Network Simulator
API
ns3::MuSnrTag Class Reference

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. More...
 
void Deserialize (TagBuffer i) override
 
double Get (uint16_t staId) const
 Return the SNR value for the given sender. More...
 
TypeId GetInstanceTypeId (void) const override
 Get the most derived TypeId for this Object. More...
 
uint32_t GetSerializedSize (void) const override
 
bool IsPresent (uint16_t staId) const
 Return true if the SNR value for the given STA-ID is present. More...
 
void Print (std::ostream &os) const override
 
void Reset (void)
 Reset the content of the tag. More...
 
void Serialize (TagBuffer i) const override
 
void Set (uint16_t staId, double snr)
 Set the SNR for the given sender to the given value. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Private Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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.
Size of this type is 56 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ MuSnrTag()

ns3::MuSnrTag::MuSnrTag ( )

Create an empty MuSnrTag.

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

Member Function Documentation

◆ Deserialize()

void ns3::MuSnrTag::Deserialize ( TagBuffer  i)
overridevirtual
Parameters
ithe 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 92 of file mu-snr-tag.cc.

References m_snrMap, sample-rng-plot::n, 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
staIdthe STA-ID of the given sender
Returns
the SNR value in linear scale

Definition at line 67 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 ( void  ) 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 39 of file mu-snr-tag.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::MuSnrTag::GetSerializedSize ( void  ) 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 74 of file mu-snr-tag.cc.

References m_snrMap.

◆ GetTypeId()

TypeId ns3::MuSnrTag::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 28 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
staIdthe STA-ID
Returns
true if the SNR value for the given STA-ID is present

Definition at line 61 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
osthe stream to print to

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

Implements ns3::Tag.

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

References m_snrMap.

◆ Reset()

void ns3::MuSnrTag::Reset ( void  )

Reset the content of the tag.

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

References m_snrMap.

◆ Serialize()

void ns3::MuSnrTag::Serialize ( TagBuffer  i) const
overridevirtual
Parameters
ithe 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 80 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
staIdthe STA-ID of the given sender
snrthe value of the SNR to set in linear scale

Definition at line 55 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 83 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: