The OTA Transmitter Control Message is by the emulator physical layer to specify the NEM Id of the source or sources transmitting the over-the-air message. The OTAManager needs to be aware of each transmitter that is part of a collaborative transmission in order to prevent delivery of the message to a transmitter. More...

#include <otatransmittercontrolmessage.h>

Inheritance diagram for EMANE::Controls::OTATransmitterControlMessage:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_OTA_TRANSMITTER }

Public Member Functions
OTATransmitterControlMessage *	clone () const override

	~OTATransmitterControlMessage ()

const OTATransmitters &	getOTATransmitters () const

std::string	serialize () const override

ControlMessageId	getId () const

Static Public Member Functions
static OTATransmitterControlMessage *	create (const Serialization &serialization)

static OTATransmitterControlMessage *	create (const OTATransmitters &transmitters)

Detailed Description

The OTA Transmitter Control Message is by the emulator physical layer to specify the NEM Id of the source or sources transmitting the over-the-air message. The OTAManager needs to be aware of each transmitter that is part of a collaborative transmission in order to prevent delivery of the message to a transmitter.

Note: Instances are immutable

Definition at line 60 of file otatransmittercontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDENTIFIER

Definition at line 127 of file otatransmittercontrolmessage.h.

Constructor & Destructor Documentation

◆ ~OTATransmitterControlMessage()

EMANE::Controls::OTATransmitterControlMessage::~OTATransmitterControlMessage ( )

Destroys an instance

Definition at line 60 of file otatransmittercontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::OTATransmitterControlMessage * EMANE::Controls::OTATransmitterControlMessage::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 127 of file otatransmittercontrolmessage.cc.

◆ create() [1/2]

EMANE::Controls::OTATransmitterControlMessage * EMANE::Controls::OTATransmitterControlMessage::create ( const Serialization & serialization )

static

Creates an OTATransmitterControlMessage instance from a serialization on the heap

Parameters

serialization Message serialization

Exceptions

SerializationException when a valid message cannot be de-serialized

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 74 of file otatransmittercontrolmessage.cc.

◆ create() [2/2]

EMANE::Controls::OTATransmitterControlMessage * EMANE::Controls::OTATransmitterControlMessage::create ( const OTATransmitters & transmitters )

static

Creates an OTATransmitterControlMessage instance on the heap

Parameters

transmitters Message Transmitters

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 97 of file otatransmittercontrolmessage.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.

◆ getOTATransmitters()

const EMANE::Controls::OTATransmitters & EMANE::Controls::OTATransmitterControlMessage::getOTATransmitters ( ) const

Gets the OTA transmitters

Returns: transmitters

Definition at line 68 of file otatransmittercontrolmessage.cc.

◆ serialize()

EMANE::Serialization EMANE::Controls::OTATransmitterControlMessage::serialize ( ) const

overridevirtual

Serializes the instance

Exceptions

SerializationException if the instance cannot be serialized

Reimplemented from EMANE::Serializable.

Definition at line 102 of file otatransmittercontrolmessage.cc.

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

Public Types

Public Member Functions

Static Public Member Functions