The Frequency Control Message is sent to the emulator physical layer to specify the frequency segment information to use on the downstream and on the upstream is sent to the MAC layer to specify received frequency segment information including per segment receive power. More...

#include <frequencycontrolmessage.h>

Inheritance diagram for EMANE::Controls::FrequencyControlMessage:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_FREQUENCY }

Public Member Functions
FrequencyControlMessage *	clone () const override

	~FrequencyControlMessage ()

const FrequencySegments &	getFrequencySegments () const

std::uint64_t	getBandwidthHz () const

ControlMessageId	getId () const

virtual Serialization	serialize () const

Static Public Member Functions
static FrequencyControlMessage *	create (std::uint64_t u64BandwidthHz, const FrequencySegments &frequencySegments)

Detailed Description

The Frequency Control Message is sent to the emulator physical layer to specify the frequency segment information to use on the downstream and on the upstream is sent to the MAC layer to specify received frequency segment information including per segment receive power.

See also: FrequencySegment

Note: Instances are immutable

Definition at line 59 of file frequencycontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDENTIFIER

Definition at line 111 of file frequencycontrolmessage.h.

Constructor & Destructor Documentation

◆ ~FrequencyControlMessage()

EMANE::Controls::FrequencyControlMessage::~FrequencyControlMessage ( )

Destroys an instance

Definition at line 69 of file frequencycontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::FrequencyControlMessage * EMANE::Controls::FrequencyControlMessage::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 91 of file frequencycontrolmessage.cc.

◆ create()

EMANE::Controls::FrequencyControlMessage * EMANE::Controls::FrequencyControlMessage::create	(	std::uint64_t	u64BandwidthHz,
		const FrequencySegments &	frequencySegments
	)

static

Creates a FrequencyControlMessage on the heap

Parameters

u64BandwidthHz	Bandwidth in Hz
frequencySegments	Frequency segments

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 73 of file frequencycontrolmessage.cc.

◆ getBandwidthHz()

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

Gets the bandwidth in Hz

Returns: bandwidth

Definition at line 85 of file frequencycontrolmessage.cc.

◆ getFrequencySegments()

const EMANE::FrequencySegments & EMANE::Controls::FrequencyControlMessage::getFrequencySegments ( ) const

Gets the frequency segments

Returns: segments

See also: FrequencySegment

Definition at line 80 of file frequencycontrolmessage.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::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