A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::AnimByteTag Class Reference

Byte tag using by Anim to uniquely identify packets. More...

#include <animation-interface.h>

+ Inheritance diagram for ns3::AnimByteTag:
+ Collaboration diagram for ns3::AnimByteTag:

Public Member Functions

virtual void Deserialize (TagBuffer i)
 Deserialize function.
uint64_t Get (void) const
 Get Uid in tag.
virtual TypeId GetInstanceTypeId (void) const
 Get Instance Type Id.
virtual uint32_t GetSerializedSize (void) const
 Get Serialized Size.
virtual void Print (std::ostream &os) const
 Print tag info.
virtual void Serialize (TagBuffer i) const
 Serialize function.
void Set (uint64_t AnimUid)
 Set global Uid in tag.

Static Public Member Functions

static TypeId GetTypeId (void)
 Get Type Id.

Private Attributes

uint64_t m_AnimUid

Additional Inherited Members

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

Detailed Description

Byte tag using by Anim to uniquely identify packets.

When Anim receives a Tx Notification we tag the packet with a unique global uint64_t identifier before recording Tx information When Anim receives Rx notifications the tag is used to retrieve Tx information recorded earlier

Definition at line 608 of file animation-interface.h.

Member Function Documentation

void ns3::AnimByteTag::Deserialize ( TagBuffer  i)
virtual

Deserialize function.

Parameters
iTag Buffer

Implements ns3::Tag.

Definition at line 1795 of file animation-interface.cc.

References m_AnimUid, and ns3::TagBuffer::ReadU64().

+ Here is the call graph for this function:

uint64_t ns3::AnimByteTag::Get ( void  ) const

Get Uid in tag.

Returns
Uid in tag

Definition at line 1811 of file animation-interface.cc.

References m_AnimUid.

Referenced by ns3::AnimationInterface::GetAnimUidFromPacket().

+ Here is the caller graph for this function:

TypeId ns3::AnimByteTag::GetInstanceTypeId ( void  ) const
virtual

Get Instance Type Id.

Returns
Type Id

Implements ns3::ObjectBase.

Definition at line 1779 of file animation-interface.cc.

References GetTypeId().

Referenced by ns3::AnimationInterface::GetAnimUidFromPacket().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t ns3::AnimByteTag::GetSerializedSize ( void  ) const
virtual

Get Serialized Size.

Returns
Serialized Size (i.e size of uint64_t)

Implements ns3::Tag.

Definition at line 1785 of file animation-interface.cc.

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

Get Type Id.

Returns
Type Id

Reimplemented from ns3::Tag.

Definition at line 1770 of file animation-interface.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::AnimByteTag::Print ( std::ostream &  os) const
virtual

Print tag info.

Parameters
osReference of ostream object

Implements ns3::Tag.

Definition at line 1800 of file animation-interface.cc.

References m_AnimUid.

void ns3::AnimByteTag::Serialize ( TagBuffer  i) const
virtual

Serialize function.

Parameters
iTag Buffer

Implements ns3::Tag.

Definition at line 1790 of file animation-interface.cc.

References m_AnimUid, and ns3::TagBuffer::WriteU64().

+ Here is the call graph for this function:

void ns3::AnimByteTag::Set ( uint64_t  AnimUid)

Member Data Documentation

uint64_t ns3::AnimByteTag::m_AnimUid
private

Definition at line 669 of file animation-interface.h.

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


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