A Discrete-Event Network Simulator
API
TimestampTag Class Reference

Timestamp tag - it carries when the packet has been sent. More...

#include "wifi-example-apps.h"

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

Public Member Functions

virtual void Deserialize (TagBuffer i)
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
virtual uint32_t GetSerializedSize (void) const
 
Time GetTimestamp (void) const
 Get the timestamp. More...
 
void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetTimestamp (Time time)
 Set the timestamp. More...
 
virtual void Deserialize (TagBuffer i)=0
 
virtual uint32_t GetSerializedSize (void) 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. 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 erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 (void)
 Get the 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

Time m_timestamp
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Timestamp tag - it carries when the packet has been sent.

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 134 of file wifi-example-apps.h.

Member Function Documentation

◆ Deserialize()

void TimestampTag::Deserialize ( TagBuffer  i)
virtual
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 310 of file wifi-example-apps.cc.

References m_timestamp, ns3::NanoSeconds(), and ns3::TagBuffer::Read().

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId TimestampTag::GetInstanceTypeId ( void  ) const
virtual

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 293 of file wifi-example-apps.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t TimestampTag::GetSerializedSize ( void  ) const
virtual
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 299 of file wifi-example-apps.cc.

◆ GetTimestamp()

Time TimestampTag::GetTimestamp ( void  ) const

Get the timestamp.

Returns
the timestamp.

Definition at line 323 of file wifi-example-apps.cc.

References m_timestamp.

Referenced by GetTypeId(), and Receiver::Receive().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId TimestampTag::GetTypeId ( void  )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 279 of file wifi-example-apps.cc.

References GetTimestamp(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), 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 TimestampTag::Print ( std::ostream &  os) const
virtual
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 329 of file wifi-example-apps.cc.

References m_timestamp.

◆ Serialize()

void TimestampTag::Serialize ( TagBuffer  i) const
virtual
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 304 of file wifi-example-apps.cc.

References ns3::Time::GetNanoSeconds(), m_timestamp, and ns3::TagBuffer::Write().

+ Here is the call graph for this function:

◆ SetTimestamp()

void TimestampTag::SetTimestamp ( Time  time)

Set the timestamp.

Parameters
timeThe timestamp.

Definition at line 318 of file wifi-example-apps.cc.

References m_timestamp.

Referenced by Sender::SendPacket().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_timestamp

Time TimestampTag::m_timestamp
private

Timestamp.

Definition at line 161 of file wifi-example-apps.h.

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


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