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:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_ANTENNA_PROFILE }

Public Member Functions
AntennaProfileControlMessage *	clone () const override

	~AntennaProfileControlMessage ()

AntennaProfileId	getAntennaProfileId () const

double	getAntennaAzimuthDegrees () const

double	getAntennaElevationDegrees () const

ControlMessageId	getId () const

virtual Serialization	serialize () const

Static Public Member Functions
static AntennaProfileControlMessage *	create (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

id	Antenna profile Id
dAntennaAzimuthDegrees	Antenna point azimuth in degrees
dAntennaElevationDegrees	Antenna 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()

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