A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::FlowIdTag Class Reference

#include <flow-id-tag.h>

+ Inheritance diagram for ns3::FlowIdTag:
+ Collaboration diagram for ns3::FlowIdTag:

Public Member Functions

 FlowIdTag ()
 FlowIdTag (uint32_t flowId)
virtual void Deserialize (TagBuffer buf)
uint32_t GetFlowId (void) const
virtual TypeId GetInstanceTypeId (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (TagBuffer buf) const
void SetFlowId (uint32_t flowId)

Static Public Member Functions

static uint32_t AllocateFlowId (void)
static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::FlowIdTag.

Private Attributes

uint32_t m_flowId

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
virtual void NotifyConstructionCompleted (void)

Detailed Description

Definition at line 27 of file flow-id-tag.h.

Constructor & Destructor Documentation

ns3::FlowIdTag::FlowIdTag ( )

Definition at line 60 of file flow-id-tag.cc.

ns3::FlowIdTag::FlowIdTag ( uint32_t  flowId)

Definition at line 65 of file flow-id-tag.cc.

Member Function Documentation

uint32_t ns3::FlowIdTag::AllocateFlowId ( void  )
static

Definition at line 83 of file flow-id-tag.cc.

void ns3::FlowIdTag::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 51 of file flow-id-tag.cc.

References m_flowId, and ns3::TagBuffer::ReadU32().

+ Here is the call graph for this function:

uint32_t ns3::FlowIdTag::GetFlowId ( void  ) const

Definition at line 77 of file flow-id-tag.cc.

References m_flowId.

Referenced by CollisionExperiment::Receive().

+ Here is the caller graph for this function:

TypeId ns3::FlowIdTag::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 36 of file flow-id-tag.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::FlowIdTag::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 flow-id-tag.cc.

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

This method returns the TypeId associated to ns3::FlowIdTag.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Tag.

Definition at line 27 of file flow-id-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:

void ns3::FlowIdTag::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 56 of file flow-id-tag.cc.

References m_flowId.

void ns3::FlowIdTag::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 flow-id-tag.cc.

References m_flowId, and ns3::TagBuffer::WriteU32().

+ Here is the call graph for this function:

void ns3::FlowIdTag::SetFlowId ( uint32_t  flowId)

Definition at line 72 of file flow-id-tag.cc.

References m_flowId.

Member Data Documentation

uint32_t ns3::FlowIdTag::m_flowId
private

Definition at line 42 of file flow-id-tag.h.

Referenced by Deserialize(), GetFlowId(), Print(), Serialize(), and SetFlowId().

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