EMANE  1.2.1
EMANE::Controls::TransmitterControlMessage Class Reference

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:
EMANE::ControlMessage EMANE::Serializable EMANE::Cloneable< ControlMessage >

Public Types

enum  { IDENTIFIER = EMANE_CONTROL_MEASSGE_TRANSMITTER }
 

Public Member Functions

 ~TransmitterControlMessage ()
 
TransmitterControlMessageclone () const override
 
const TransmittersgetTransmitters () const
 
ControlMessageId getId () const
 
virtual Serialization serialize () const
 

Static Public Member Functions

static TransmitterControlMessagecreate (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
transmittersList 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()


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