A simple example of an Tag implementation. More...

Inheritance diagram for MyTag:

Collaboration diagram for MyTag:

Public Member Functions
void	Deserialize (TagBuffer i) override

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint32_t	GetSerializedSize () const override

uint8_t	GetSimpleValue () const
	Get the tag value.

void	Print (std::ostream &os) const override

void	Serialize (TagBuffer i) const override

void	SetSimpleValue (uint8_t value)
	Set the tag value.

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 the 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
uint8_t	m_simpleValue
	tag value

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

A simple example of an Tag implementation.

Definition at line 32 of file main-packet-tag.cc.

Member Function Documentation

◆ Deserialize()

void MyTag::Deserialize ( TagBuffer i )

overridevirtual

Parameters

i	the 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 95 of file main-packet-tag.cc.

References m_simpleValue, and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId MyTag::GetInstanceTypeId ( ) const

overridevirtual

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 77 of file main-packet-tag.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t MyTag::GetSerializedSize ( ) const

overridevirtual

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 83 of file main-packet-tag.cc.

◆ GetSimpleValue()

uint8_t MyTag::GetSimpleValue ( ) const

Get the tag value.

Returns: the tag value.

Definition at line 113 of file main-packet-tag.cc.

References m_simpleValue.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId MyTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 63 of file main-packet-tag.cc.

References GetSimpleValue(), 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:

◆ Print()

void MyTag::Print ( std::ostream & os ) const

overridevirtual

Parameters

os	the 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 main-packet-tag.cc.

References m_simpleValue.

◆ Serialize()

void MyTag::Serialize ( TagBuffer i ) const

overridevirtual

Parameters

i	the 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 89 of file main-packet-tag.cc.

References m_simpleValue, and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

◆ SetSimpleValue()

void MyTag::SetSimpleValue ( uint8_t value )

Set the tag value.

Parameters

value The tag value.

Definition at line 107 of file main-packet-tag.cc.

References m_simpleValue.

Member Data Documentation

◆ m_simpleValue

uint8_t MyTag::m_simpleValue

private

tag value

Definition at line 59 of file main-packet-tag.cc.

Referenced by Deserialize(), GetSimpleValue(), Print(), Serialize(), and SetSimpleValue().

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

src/network/examples/main-packet-tag.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetSimpleValue()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetSimpleValue()

Member Data Documentation

◆ m_simpleValue