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

The aim of the AmpduTag is to provide means for a MAC to specify that a packet includes A-MPDU since this is done in HT-SIG and there is no HT-SIG representation in ns-3. More...

#include "ampdu-tag.h"

+ Inheritance diagram for ns3::AmpduTag:
+ Collaboration diagram for ns3::AmpduTag:

Public Member Functions

 AmpduTag ()
 Create a AmpduTag with the default =0 no Ampdu. More...
 
virtual void Deserialize (TagBuffer i)
 
bool GetAmpdu (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint8_t GetNoOfMpdus (void) const
 
virtual uint32_t GetSerializedSize () const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetAmpdu (bool supported)
 Set m_ampdu to 1. More...
 
void SetNoOfMpdus (uint8_t noofmpdus)
 
- 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

uint8_t m_ampdu
 Flag whether it is an A-MPDU. More...
 
uint8_t m_noOfMpdus
 number of MPDUs in the A-MPDU 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

The aim of the AmpduTag is to provide means for a MAC to specify that a packet includes A-MPDU since this is done in HT-SIG and there is no HT-SIG representation in ns-3.

Introspection did not find any typical Config paths.


Attributes

  • Ampdu Exists: The value that indicates that the packet contains an AMPDU

No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 36 of file ampdu-tag.h.

Constructor & Destructor Documentation

ns3::AmpduTag::AmpduTag ( )

Create a AmpduTag with the default =0 no Ampdu.

Definition at line 50 of file ampdu-tag.cc.

Member Function Documentation

void ns3::AmpduTag::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 82 of file ampdu-tag.cc.

References m_ampdu, m_noOfMpdus, and ns3::TagBuffer::ReadU8().

+ Here is the call graph for this function:

bool ns3::AmpduTag::GetAmpdu ( void  ) const
Returns
true if it is an A-MPDU, false otherwise.

Returns m_ampdu

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

References m_ampdu.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

TypeId ns3::AmpduTag::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 45 of file ampdu-tag.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint8_t ns3::AmpduTag::GetNoOfMpdus ( void  ) const
Returns
the number of MPDUs in an A-MPDU

Returns the number of MPDUs in an A-MPDU

Definition at line 95 of file ampdu-tag.cc.

References m_noOfMpdus.

Referenced by ns3::MacLow::DeaggregateAmpduAndReceive(), ns3::MacLow::ReceiveError(), ns3::YansWifiPhy::StartReceivePreambleAndHeader(), and ns3::MacLow::StartTransmission().

+ Here is the caller graph for this function:

uint32_t ns3::AmpduTag::GetSerializedSize ( ) 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 69 of file ampdu-tag.cc.

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

Definition at line 30 of file ampdu-tag.cc.

References GetAmpdu(), ns3::MakeUintegerAccessor(), 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::AmpduTag::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 101 of file ampdu-tag.cc.

References m_ampdu.

void ns3::AmpduTag::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 75 of file ampdu-tag.cc.

References m_ampdu, m_noOfMpdus, and ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

void ns3::AmpduTag::SetAmpdu ( bool  supported)

Set m_ampdu to 1.

Definition at line 56 of file ampdu-tag.cc.

References m_ampdu.

Referenced by ns3::MacLow::AggregateToAmpdu(), and ns3::MacLow::ForwardDown().

+ Here is the caller graph for this function:

void ns3::AmpduTag::SetNoOfMpdus ( uint8_t  noofmpdus)
Parameters
noofmpdusthe number of MPDUs

Set the number of MPDUs in the A-MPDU.

Definition at line 62 of file ampdu-tag.cc.

References m_noOfMpdus, and NS_ASSERT.

Referenced by ns3::MacLow::AggregateToAmpdu(), and ns3::MacLow::ForwardDown().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::AmpduTag::m_ampdu
private

Flag whether it is an A-MPDU.

Definition at line 77 of file ampdu-tag.h.

Referenced by Deserialize(), GetAmpdu(), Print(), Serialize(), and SetAmpdu().

uint8_t ns3::AmpduTag::m_noOfMpdus
private

number of MPDUs in the A-MPDU

Definition at line 78 of file ampdu-tag.h.

Referenced by Deserialize(), GetNoOfMpdus(), Serialize(), and SetNoOfMpdus().


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