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
void	Deserialize (TagBuffer i) override
	Deserialize function.

uint64_t	Get () const
	Get Uid in tag.

TypeId	GetInstanceTypeId () const override
	Get Instance Type Id.

uint32_t	GetSerializedSize () const override
	Get Serialized Size.

void	Print (std::ostream &os) const override
	Print tag info.

void	Serialize (TagBuffer i) const override
	Serialize function.

void	Set (uint64_t AnimUid)
	Set global Uid in tag.

virtual void	Deserialize (TagBuffer i)=0

virtual uint32_t	GetSerializedSize () const =0

virtual void	Print (std::ostream &os) const =0

virtual void	Serialize (TagBuffer i) const =0

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get Type Id.

Static Public Member Functions inherited from ns3::Tag
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
uint64_t	m_AnimUid
	the UID

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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 1491 of file animation-interface.h.

Member Function Documentation

◆ Deserialize()

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

overridevirtual

Deserialize function.

Parameters

i	Tag Buffer

Implements ns3::Tag.

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

References ns3::TagBuffer::ReadU64().

Here is the call graph for this function:

◆ Get()

uint64_t ns3::AnimByteTag::Get ( ) const

Get Uid in tag.

Returns: Uid in tag

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

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

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::AnimByteTag::GetInstanceTypeId ( ) const

overridevirtual

Get Instance Type Id.

Returns: Type Id

Implements ns3::ObjectBase.

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

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

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::AnimByteTag::GetSerializedSize ( ) const

overridevirtual

Get Serialized Size.

Returns: Serialized Size (i.e size of uint64_t)

Implements ns3::Tag.

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

◆ GetTypeId()

TypeId ns3::AnimByteTag::GetTypeId ( )

static

Get Type Id.

Returns: Type Id

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Print()

void ns3::AnimByteTag::Print ( std::ostream & os ) const

overridevirtual

Print tag info.

Parameters

os	Reference of ostream object

Implements ns3::Tag.

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

◆ Serialize()

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

overridevirtual

Serialize function.

Parameters

i	Tag Buffer

Implements ns3::Tag.

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

References ns3::TagBuffer::WriteU64().

Here is the call graph for this function:

◆ Set()

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

Set global Uid in tag.

Parameters

AnimUid global Uid

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

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_AnimUid

uint64_t ns3::AnimByteTag::m_AnimUid

private

the UID

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

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

src/netanim/model/animation-interface.h
src/netanim/model/animation-interface.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Deserialize()

◆ Get()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ Set()

Member Data Documentation

◆ m_AnimUid