A Discrete-Event Network Simulator
API
ns3::TimestampTag Class Reference

Timestamp tag for associating a timestamp with a packet. More...

#include "timestamp-tag.h"

+ Inheritance diagram for ns3::TimestampTag:
+ Collaboration diagram for ns3::TimestampTag:

Public Member Functions

 TimestampTag ()
 Construct a new TimestampTag object. More...
 
 TimestampTag (Time timestamp)
 Construct a new TimestampTag object with the given timestamp. More...
 
void Deserialize (TagBuffer i) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
uint32_t GetSerializedSize () const override
 
Time GetTimestamp () const
 Get the Timestamp object. More...
 
void Print (std::ostream &os) const override
 
void Serialize (TagBuffer i) const override
 
void SetTimestamp (Time timestamp)
 Set the Timestamp object. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Private Attributes

Time m_timestamp {0}
 Timestamp. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Timestamp tag for associating a timestamp with a packet.

It would have been more realistic to include this info in a header. Here we show how to avoid the extra overhead in a simulation.

Definition at line 38 of file timestamp-tag.h.

Constructor & Destructor Documentation

◆ TimestampTag() [1/2]

ns3::TimestampTag::TimestampTag ( )
default

Construct a new TimestampTag object.

◆ TimestampTag() [2/2]

ns3::TimestampTag::TimestampTag ( Time  timestamp)

Construct a new TimestampTag object with the given timestamp.

Parameters
timestampThe timestamp

Definition at line 33 of file timestamp-tag.cc.

Member Function Documentation

◆ Deserialize()

void ns3::TimestampTag::Deserialize ( TagBuffer  i)
overridevirtual
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 67 of file timestamp-tag.cc.

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

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::TimestampTag::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 49 of file timestamp-tag.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::TimestampTag::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 55 of file timestamp-tag.cc.

◆ GetTimestamp()

Time ns3::TimestampTag::GetTimestamp ( ) const

Get the Timestamp object.

Returns
Time for this tag

Definition at line 79 of file timestamp-tag.cc.

References m_timestamp.

Referenced by Receiver::Receive(), and ns3::DelayJitterEstimation::RecordRx().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 39 of file timestamp-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:

◆ Print()

void ns3::TimestampTag::Print ( std::ostream &  os) const
overridevirtual
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 73 of file timestamp-tag.cc.

References ns3::Time::As(), m_timestamp, and ns3::Time::S.

+ Here is the call graph for this function:

◆ Serialize()

void ns3::TimestampTag::Serialize ( TagBuffer  i) const
overridevirtual
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 61 of file timestamp-tag.cc.

References ns3::Time::GetTimeStep(), m_timestamp, and ns3::TagBuffer::WriteU64().

+ Here is the call graph for this function:

◆ SetTimestamp()

void ns3::TimestampTag::SetTimestamp ( Time  timestamp)

Set the Timestamp object.

Parameters
timestampTimestamp to assign to tag

Definition at line 85 of file timestamp-tag.cc.

References m_timestamp.

Referenced by Sender::SendPacket().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_timestamp

Time ns3::TimestampTag::m_timestamp {0}
private

Timestamp.

Definition at line 77 of file timestamp-tag.h.

Referenced by Deserialize(), GetTimestamp(), Print(), Serialize(), and SetTimestamp().


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