A Discrete-Event Network Simulator
API
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 (WifiTxVector txVector, WifiPreamble preamble, enum mpduType mpdutype)
 Constructor. More...
 
virtual void Deserialize (TagBuffer i)
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
enum mpduType GetMpduType (void) const
 Getter for mpduType parameter. More...
 
virtual uint32_t GetSerializedSize (void) const
 
WifiPreamble GetWifiPreamble (void) const
 Getter for WifiPreamble parameter. More...
 
WifiTxVector GetWifiTxVector (void) const
 Getter for WifiTxVector parameter. More...
 
virtual void Print (std::ostream &os) const
 
virtual 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)
 
- 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

enum mpduType m_mpduType
 
int32_t m_wifiPreamble
 
WifiTxVector m_wifiTxVector
 

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

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

ns3::WifiPhyTag::WifiPhyTag ( )

Constructor.

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

ns3::WifiPhyTag::WifiPhyTag ( WifiTxVector  txVector,
WifiPreamble  preamble,
enum mpduType  mpdutype 
)

Constructor.

Parameters
txVectorthe WifiTxVector
preamblethe WifiPreamble
mpduTypethe mpduType

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

Member Function Documentation

void ns3::WifiPhyTag::Deserialize ( TagBuffer  i)
virtual
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 60 of file wifi-phy-tag.cc.

References m_mpduType, m_wifiPreamble, m_wifiTxVector, ns3::TagBuffer::ReadU16(), ns3::TagBuffer::ReadU32(), ns3::TagBuffer::ReadU8(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNess(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetRetries(), ns3::WifiTxVector::SetShortGuardInterval(), ns3::WifiTxVector::SetStbc(), and ns3::WifiTxVector::SetTxPowerLevel().

+ Here is the call graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

enum mpduType ns3::WifiPhyTag::GetMpduType ( void  ) const

Getter for mpduType parameter.

Returns
mpduType the mpduType

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

References m_mpduType.

Referenced by ns3::SpectrumWifiPhy::StartRx().

+ Here is the caller graph for this function:

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

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

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

WifiPreamble ns3::WifiPhyTag::GetWifiPreamble ( void  ) const

Getter for WifiPreamble parameter.

Returns
preamble the WifiPreamble

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

References m_wifiPreamble.

Referenced by ns3::SpectrumWifiPhy::StartRx().

+ Here is the caller graph for this function:

WifiTxVector ns3::WifiPhyTag::GetWifiTxVector ( void  ) const

Getter for WifiTxVector parameter.

Returns
the WifiTxVector

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

References m_wifiTxVector.

Referenced by ns3::SpectrumWifiPhy::StartRx().

+ Here is the caller graph for this function:

void ns3::WifiPhyTag::Print ( std::ostream &  os) const
virtual
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 73 of file wifi-phy-tag.cc.

References m_mpduType, m_wifiPreamble, and m_wifiTxVector.

void ns3::WifiPhyTag::Serialize ( TagBuffer  i) const
virtual
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 46 of file wifi-phy-tag.cc.

References ns3::WifiTxVector::GetMode(), ns3::WifiTxVector::GetNess(), ns3::WifiTxVector::GetNss(), ns3::WifiTxVector::GetRetries(), ns3::WifiTxVector::GetTxPowerLevel(), ns3::WifiMode::GetUid(), ns3::WifiTxVector::IsShortGuardInterval(), ns3::WifiTxVector::IsStbc(), m_mpduType, m_wifiPreamble, m_wifiTxVector, ns3::TagBuffer::WriteU16(), ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

Member Data Documentation

enum mpduType ns3::WifiPhyTag::m_mpduType
private

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

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

int32_t ns3::WifiPhyTag::m_wifiPreamble
private

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

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

WifiTxVector ns3::WifiPhyTag::m_wifiTxVector
private

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

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


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