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. More...
 
uint64_t Get (void) const
 Get Uid in tag. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get Instance Type Id. More...
 
virtual uint32_t GetSerializedSize (void) const
 Get Serialized Size. More...
 
virtual void Print (std::ostream &os) const
 Print tag info. More...
 
virtual void Serialize (TagBuffer i) const
 Serialize function. More...
 
void Set (uint64_t AnimUid)
 Set global Uid in tag. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get 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

uint64_t m_AnimUid
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

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 793 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 2408 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 2424 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 2392 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 2398 of file animation-interface.cc.

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

Get Type Id.

Returns
Type Id

Definition at line 2383 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 2413 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 2403 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 854 of file animation-interface.h.

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


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