ns3::WifiPhyTag Class Reference

Tag for WifiTxVector and WifiPreamble information to be embedded in outgoing transmissions as a PacketTag. More...

#include "wifi-phy-tag.h"

Inheritance diagram for ns3::WifiPhyTag:

Collaboration diagram for ns3::WifiPhyTag:

Public Member Functions
	WifiPhyTag ()
	Constructor. More...
	WifiPhyTag (WifiPreamble preamble, WifiModulationClass modulation, uint8_t frameComplete)
	Constructor. More...
void	Deserialize (TagBuffer i)
uint8_t	GetFrameComplete (void) const
	Getter for frameComplete parameter. More...
TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...
WifiModulationClass	GetModulation (void) const
	Getter for modulation parameter. More...
WifiPreamble	GetPreambleType (void) const
	Getter for preamble parameter. More...
uint32_t	GetSerializedSize (void) const
void	Print (std::ostream &os) const
void	Serialize (TagBuffer i) const
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
uint8_t	m_frameComplete
	Used to indicate that TX stopped sending before the end of the frame. More...
WifiModulationClass	m_modulation
	modulation used for transmission More...
WifiPreamble	m_preamble
	preamble type 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...
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Tag for WifiTxVector and WifiPreamble information to be embedded in outgoing transmissions as a PacketTag.

Definition at line 36 of file wifi-phy-tag.h.

Constructor & Destructor Documentation

WifiPhyTag() [1/2]

ns3::WifiPhyTag::WifiPhyTag

(

)

Constructor.

Definition at line 68 of file wifi-phy-tag.cc.

WifiPhyTag() [2/2]

ns3::WifiPhyTag::WifiPhyTag	(	WifiPreamble	preamble,
		WifiModulationClass	modulation,
		uint8_t	frameComplete
	)

Constructor.

Parameters

preamble	the preamble type
modulation	the modulation
frameComplete	the frameComplete

Definition at line 72 of file wifi-phy-tag.cc.

Member Function Documentation

Deserialize()

void ns3::WifiPhyTag::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 55 of file wifi-phy-tag.cc.

References m_frameComplete, m_modulation, m_preamble, and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

GetFrameComplete()

uint8_t ns3::WifiPhyTag::GetFrameComplete

(

void

)

const

Getter for frameComplete parameter.

Returns

the frameComplete parameter, i.e. 0 if the frame is not complete, 1 otherwise.

Definition at line 92 of file wifi-phy-tag.cc.

References m_frameComplete.

GetInstanceTypeId()

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

virtual

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 35 of file wifi-phy-tag.cc.

References GetTypeId().

Here is the call graph for this function:

GetModulation()

WifiModulationClass ns3::WifiPhyTag::GetModulation

(

void

)

const

Getter for modulation parameter.

Returns

the modulation

Definition at line 86 of file wifi-phy-tag.cc.

References m_modulation.

GetPreambleType()

WifiPreamble ns3::WifiPhyTag::GetPreambleType

(

void

)

const

Getter for preamble parameter.

Returns

the preamble type

Definition at line 80 of file wifi-phy-tag.cc.

References m_preamble.

GetSerializedSize()

uint32_t ns3::WifiPhyTag::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 41 of file wifi-phy-tag.cc.

GetTypeId()

TypeId ns3::WifiPhyTag::GetTypeId ( void  )

static

Get the type ID.

Returns

the object TypeId

Definition at line 26 of file wifi-phy-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:

Print()

void ns3::WifiPhyTag::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 63 of file wifi-phy-tag.cc.

References m_frameComplete, m_modulation, and m_preamble.

Serialize()

void ns3::WifiPhyTag::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 47 of file wifi-phy-tag.cc.

References m_frameComplete, m_modulation, m_preamble, and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

Member Data Documentation

m_frameComplete

uint8_t ns3::WifiPhyTag::m_frameComplete

private

Used to indicate that TX stopped sending before the end of the frame.

Definition at line 83 of file wifi-phy-tag.h.

Referenced by Deserialize(), GetFrameComplete(), Print(), and Serialize().

m_modulation

WifiModulationClass ns3::WifiPhyTag::m_modulation

private

modulation used for transmission

Definition at line 82 of file wifi-phy-tag.h.

Referenced by Deserialize(), GetModulation(), Print(), and Serialize().

m_preamble

WifiPreamble ns3::WifiPhyTag::m_preamble

private

preamble type

Definition at line 81 of file wifi-phy-tag.h.

Referenced by Deserialize(), GetPreambleType(), Print(), and Serialize().

---

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

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