Time Stamp Control Message is sent to the emulator physical layer to specify the time that should be used for the tx time stamp in the EMANE::CommonPHYHeader. More...

#include <timestampcontrolmessage.h>

Inheritance diagram for EMANE::Controls::TimeStampControlMessage:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_TIME_STAMP }

Public Member Functions
TimeStampControlMessage *	clone () const override

	~TimeStampControlMessage ()

TimePoint	getTimeStamp () const

ControlMessageId	getId () const

virtual Serialization	serialize () const

Static Public Member Functions
static TimeStampControlMessage *	create (const TimePoint &timestamp)

Detailed Description

Time Stamp Control Message is sent to the emulator physical layer to specify the time that should be used for the tx time stamp in the EMANE::CommonPHYHeader.

Note: If this control message is not sent along with the downstream packet the emulator physical layer will use the current time for the tx time stamp.; The Start of Transmission (SoT) is the tx time stamp + propagation delay + offset of the first frequency segment.; Instances are immutable

Definition at line 60 of file timestampcontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDENTIFIER

Definition at line 101 of file timestampcontrolmessage.h.

Constructor & Destructor Documentation

◆ ~TimeStampControlMessage()

EMANE::Controls::TimeStampControlMessage::~TimeStampControlMessage ( )

Destroys an instance

Definition at line 60 of file timestampcontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::TimeStampControlMessage * EMANE::Controls::TimeStampControlMessage::clone ( ) const

overridevirtual

Clones the control message on the heap

Returns: cloned message

Note: Caller assumes ownership of the clone

Implements EMANE::Cloneable< ControlMessage >.

Definition at line 75 of file timestampcontrolmessage.cc.

◆ create()

EMANE::Controls::TimeStampControlMessage * EMANE::Controls::TimeStampControlMessage::create ( const TimePoint & timestamp )

static

Creates a TimeStampControlMessage on the heap

Parameters

timestamp Time value to use as the tx time in the common PHY Header

Note: Once a control message is passed to another NEM layer using EMANE::UpstreamTransport::processUpstreamPacket(), EMANE::UpstreamTransport::processUpstreamControl(), EMANE::DownstreamTransport::processDownstreamPacket() or EMANE::DownstreamTransport::processDownstreamControl() object ownership is transferred to the emulator infrastructure along with deallocation responsibility. It is not valid to use a control message instance after it has been passed to another layer.

Definition at line 64 of file timestampcontrolmessage.cc.

◆ getId()

ControlMessageId EMANE::ControlMessage::getId ( ) const

inlineinherited

Gets the control message id

Returns: control messase id

Definition at line 64 of file controlmessage.h.

◆ getTimeStamp()

EMANE::TimePoint EMANE::Controls::TimeStampControlMessage::getTimeStamp ( ) const

Gets the time stamp

Returns: time stamp

Definition at line 69 of file timestampcontrolmessage.cc.

◆ serialize()

virtual Serialization EMANE::Serializable::serialize ( ) const

inlinevirtualinherited

Gets the serialized form of the object

Returns: serialization

Exceptions

SerializationException

Note: Most objects use Google Protocol Buffers to perform serialization. This is why the Serialization type is a std::string. The serialized data is binary, non-printable data. The std::string just provides a simple API.; https://developers.google.com/protocol-buffers/

Reimplemented in EMANE::Controls::R2RISelfMetricControlMessage, EMANE::Controls::R2RINeighborMetricControlMessage, EMANE::Controls::OTATransmitterControlMessage, EMANE::Controls::R2RIQueueMetricControlMessage, EMANE::Controls::FlowControlControlMessage, EMANE::Events::CommEffectEvent, EMANE::Events::AntennaProfileEvent, EMANE::Events::FadingSelectionEvent, EMANE::Events::LocationEvent, EMANE::Events::PathlossEvent, EMANE::Models::IEEE80211ABG::MACHeaderMessage, EMANE::Models::TDMA::BaseModelMessage, EMANE::Models::TimingAnalysis::ShimHeaderMessage, EMANE::Messages::LoggerRecordMessage, EMANE::Models::RFPipe::MACHeaderMessage, EMANE::Models::IEEE80211ABG::OneHopNeighborsEvent, and EMANE::Models::CommEffect::ShimHeader.

Definition at line 69 of file serializable.h.

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

Public Types

Public Member Functions

Static Public Member Functions