ns3::SnrTag Class Reference

Doxygen introspection did not find any typical Config paths. More...

#include <snr-tag.h>

Inheritance diagram for ns3::SnrTag:

Collaboration diagram for ns3::SnrTag:

Public Member Functions
	SnrTag ()
	Create a SnrTag with the default snr 0. More...
	SnrTag (double snr)
	Create a SnrTag with the given snr value. More...
virtual void	Deserialize (TagBuffer i)
double	Get (void) const
	Return the SNR value. More...
virtual TypeId	GetInstanceTypeId (void) const
virtual uint32_t	GetSerializedSize (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	Set (double snr)
	Set the SNR 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
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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

Private Attributes
double	m_snr
	SNR value. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Doxygen introspection did not find any typical Config paths.

Attributes

• Snr: The snr of the last packet received
  • Set with class: ns3::DoubleValue
  • Underlying type: double -1.79769e+308:1.79769e+308
  • Flags: read

No TraceSources are defined for this type.

Definition at line 34 of file snr-tag.h.

Constructor & Destructor Documentation

ns3::SnrTag::SnrTag

(

)

Create a SnrTag with the default snr 0.

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

ns3::SnrTag::SnrTag

(

double

snr

)

Create a SnrTag with the given snr value.

Parameters

snr	the given SNR value

Definition at line 57 of file snr-tag.cc.

Member Function Documentation

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

virtual

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 74 of file snr-tag.cc.

References m_snr, and ns3::TagBuffer::ReadDouble().

Here is the call graph for this function:

double ns3::SnrTag::Get

(

void

)

const

Return the SNR value.

Returns

the SNR value

Definition at line 89 of file snr-tag.cc.

References m_snr.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::SnrTag::GetInstanceTypeId ( void  ) const

virtual

Returns

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

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

Implements ns3::ObjectBase.

Definition at line 48 of file snr-tag.cc.

References GetTypeId().

Here is the call graph for this function:

uint32_t ns3::SnrTag::GetSerializedSize ( void  ) const

virtual

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 64 of file snr-tag.cc.

TypeId ns3::SnrTag::GetTypeId ( void  )

static

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

References Get(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

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 79 of file snr-tag.cc.

References m_snr.

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

virtual

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 69 of file snr-tag.cc.

References m_snr, and ns3::TagBuffer::WriteDouble().

Here is the call graph for this function:

void ns3::SnrTag::Set

(

double

snr

)

Set the SNR to the given value.

Parameters

snr	the value of the snr to set

Definition at line 84 of file snr-tag.cc.

References m_snr.

Referenced by ns3::MacLow::SendAckAfterData(), and ns3::MacLow::SendCtsAfterRts().

Here is the caller graph for this function:

Member Data Documentation

double ns3::SnrTag::m_snr

private

SNR value.

Definition at line 69 of file snr-tag.h.

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

---

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

• src/wifi/model/snr-tag.h
• src/wifi/model/snr-tag.cc