The Transmitter Control Message is sent to the emulator physical layer to specify the NEM Id of the source or sources transmitting the over-the-air message. More...

#include <transmittercontrolmessage.h>

Inheritance diagram for EMANE::Controls::TransmitterControlMessage:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_TRANSMITTER }

Public Member Functions
	~TransmitterControlMessage ()

TransmitterControlMessage *	clone () const override

const Transmitters &	getTransmitters () const

ControlMessageId	getId () const

virtual Serialization	serialize () const

Static Public Member Functions
static TransmitterControlMessage *	create (const Transmitters &transmitters)

Detailed Description

The Transmitter Control Message is sent to the emulator physical layer to specify the NEM Id of the source or sources transmitting the over-the-air message.

See also: Transmitter

Note: Instances are immutable

Definition at line 57 of file transmittercontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDENTIFIER

Definition at line 100 of file transmittercontrolmessage.h.

Constructor & Destructor Documentation

◆ ~TransmitterControlMessage()

EMANE::Controls::TransmitterControlMessage::~TransmitterControlMessage ( )

Destroys an instance

Definition at line 61 of file transmittercontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::TransmitterControlMessage * EMANE::Controls::TransmitterControlMessage::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 77 of file transmittercontrolmessage.cc.

◆ create()

EMANE::Controls::TransmitterControlMessage * EMANE::Controls::TransmitterControlMessage::create ( const Transmitters & transmitters )

static

Creates a TransmitterControlMessage on the heap

Parameters

transmitters List of source NEMs

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 71 of file transmittercontrolmessage.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.

◆ getTransmitters()

const EMANE::Transmitters & EMANE::Controls::TransmitterControlMessage::getTransmitters ( ) const

Gets the transmitters

Returns: transmitters

See also: Transmitter

Definition at line 65 of file transmittercontrolmessage.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::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