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

Tag to perform Delay and Jitter estimations. More...

+ Inheritance diagram for ns3::DelayJitterEstimationTimestampTag:
+ Collaboration diagram for ns3::DelayJitterEstimationTimestampTag:

Public Member Functions

 DelayJitterEstimationTimestampTag ()
 
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 GetTxTime (void) const
 Get the Transmission time stored in the tag. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
- 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...
 
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_creationTime
 The time stored in the tag. 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

Tag to perform Delay and Jitter estimations.

The tag holds the packet's creation timestamp

Definition at line 33 of file delay-jitter-estimation.cc.

Constructor & Destructor Documentation

◆ DelayJitterEstimationTimestampTag()

ns3::DelayJitterEstimationTimestampTag::DelayJitterEstimationTimestampTag ( )

Definition at line 59 of file delay-jitter-estimation.cc.

Member Function Documentation

◆ Deserialize()

void ns3::DelayJitterEstimationTimestampTag::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 96 of file delay-jitter-estimation.cc.

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

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::DelayJitterEstimationTimestampTag::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 80 of file delay-jitter-estimation.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::DelayJitterEstimationTimestampTag::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 86 of file delay-jitter-estimation.cc.

◆ GetTxTime()

Time ns3::DelayJitterEstimationTimestampTag::GetTxTime ( void  ) const

Get the Transmission time stored in the tag.

Returns
the transmission time

Definition at line 106 of file delay-jitter-estimation.cc.

References m_creationTime.

Referenced by ns3::DelayJitterEstimation::RecordRx().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 65 of file delay-jitter-estimation.cc.

References m_creationTime, 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 ns3::DelayJitterEstimationTimestampTag::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 101 of file delay-jitter-estimation.cc.

References m_creationTime.

◆ Serialize()

void ns3::DelayJitterEstimationTimestampTag::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 91 of file delay-jitter-estimation.cc.

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_creationTime

Time ns3::DelayJitterEstimationTimestampTag::m_creationTime
private

The time stored in the tag.

Definition at line 56 of file delay-jitter-estimation.cc.

Referenced by Deserialize(), GetTxTime(), GetTypeId(), Print(), and Serialize().


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