EMANE  1.2.1
EMANE::Controls::AntennaProfileControlMessage Class Reference

Antenna Profile Control Message is sent to the emulator physical layer to update antenna profile selection and/or antenna pointing information. More...

#include <antennaprofilecontrolmessage.h>

Inheritance diagram for EMANE::Controls::AntennaProfileControlMessage:
EMANE::ControlMessage EMANE::Serializable EMANE::Cloneable< ControlMessage >

Public Types

enum  { IDENTIFIER = EMANE_CONTROL_MEASSGE_ANTENNA_PROFILE }
 

Public Member Functions

AntennaProfileControlMessageclone () const override
 
 ~AntennaProfileControlMessage ()
 
AntennaProfileId getAntennaProfileId () const
 
double getAntennaAzimuthDegrees () const
 
double getAntennaElevationDegrees () const
 
ControlMessageId getId () const
 
virtual Serialization serialize () const
 

Static Public Member Functions

static AntennaProfileControlMessagecreate (AntennaProfileId id, double dAntennaAzimuthDegrees, double dAntennaElevationDegrees)
 

Detailed Description

Antenna Profile Control Message is sent to the emulator physical layer to update antenna profile selection and/or antenna pointing information.

Note
Instances are immutable
Will result in the emulator physical layer publishing an Events::AntennaProfileEvent to inform all NEMs of the change.

Definition at line 58 of file antennaprofilecontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
IDENTIFIER 

Definition at line 117 of file antennaprofilecontrolmessage.h.

Constructor & Destructor Documentation

◆ ~AntennaProfileControlMessage()

EMANE::Controls::AntennaProfileControlMessage::~AntennaProfileControlMessage ( )

Destroys an instance

Definition at line 82 of file antennaprofilecontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::AntennaProfileControlMessage * EMANE::Controls::AntennaProfileControlMessage::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 111 of file antennaprofilecontrolmessage.cc.

◆ create()

EMANE::Controls::AntennaProfileControlMessage * EMANE::Controls::AntennaProfileControlMessage::create ( AntennaProfileId  id,
double  dAntennaAzimuthDegrees,
double  dAntennaElevationDegrees 
)
static

Creates an AntennaProfileControlMessage instance on the heap

Parameters
idAntenna profile Id
dAntennaAzimuthDegreesAntenna point azimuth in degrees
dAntennaElevationDegreesAntenna pointing elevation in degrees
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 103 of file antennaprofilecontrolmessage.cc.

◆ getAntennaAzimuthDegrees()

double EMANE::Controls::AntennaProfileControlMessage::getAntennaAzimuthDegrees ( ) const

Gets the antenna pointing azimuth in degrees

Returns
azimuth

Definition at line 90 of file antennaprofilecontrolmessage.cc.

◆ getAntennaElevationDegrees()

double EMANE::Controls::AntennaProfileControlMessage::getAntennaElevationDegrees ( ) const

Gets the antenna pointing elevation in degrees

Returns
elevation

Definition at line 96 of file antennaprofilecontrolmessage.cc.

◆ getAntennaProfileId()

EMANE::AntennaProfileId EMANE::Controls::AntennaProfileControlMessage::getAntennaProfileId ( ) const

Gets the antenna profile Id

Returns
Profile id

Definition at line 84 of file antennaprofilecontrolmessage.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.

◆ serialize()


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