The Frequency of Interest Control Message is sent to the emulator physical layer to specify receive frequencies. These frequencies are monitored by the SpectrumMonitor. More...

#include <frequencyofinterestcontrolmessage.h>

Inheritance diagram for EMANE::Controls::FrequencyOfInterestControlMessage:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_FREQUENCY_OF_INTEREST }

Public Member Functions
FrequencyOfInterestControlMessage *	clone () const override

	~FrequencyOfInterestControlMessage ()

const FrequencySet &	getFrequencySet () const

std::uint64_t	getBandwidthHz () const

ControlMessageId	getId () const

virtual Serialization	serialize () const

Static Public Member Functions
static FrequencyOfInterestControlMessage *	create (std::uint64_t u64BandwidthHz, const FrequencySet &frequencySet)

Detailed Description

The Frequency of Interest Control Message is sent to the emulator physical layer to specify receive frequencies. These frequencies are monitored by the SpectrumMonitor.

Note: Instances are immutable

Definition at line 56 of file frequencyofinterestcontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDENTIFIER

Definition at line 108 of file frequencyofinterestcontrolmessage.h.

Constructor & Destructor Documentation

◆ ~FrequencyOfInterestControlMessage()

EMANE::Controls::FrequencyOfInterestControlMessage::~FrequencyOfInterestControlMessage ( )

Destroys an instance

Definition at line 70 of file frequencyofinterestcontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::FrequencyOfInterestControlMessage * EMANE::Controls::FrequencyOfInterestControlMessage::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 92 of file frequencyofinterestcontrolmessage.cc.

◆ create()

EMANE::Controls::FrequencyOfInterestControlMessage * EMANE::Controls::FrequencyOfInterestControlMessage::create	(	std::uint64_t	u64BandwidthHz,
		const FrequencySet &	frequencySet
	)

static

Creates a FrequencyOfInterestControlMessage on the heap

Parameters

u64BandwidthHz	Bandwidth in Hz
frequencySet	Frequency set

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 frequencyofinterestcontrolmessage.cc.

◆ getBandwidthHz()

std::uint64_t EMANE::Controls::FrequencyOfInterestControlMessage::getBandwidthHz ( ) const

Gets the bandwidth in Hz

Returns: bandwidth

Definition at line 86 of file frequencyofinterestcontrolmessage.cc.

◆ getFrequencySet()

const EMANE::FrequencySet & EMANE::Controls::FrequencyOfInterestControlMessage::getFrequencySet ( ) const

Gets the frequency segments

Returns: segments

See also: FrequencySegment

Definition at line 81 of file frequencyofinterestcontrolmessage.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