EMANE  1.2.1
EMANE::Controls::FrequencyControlMessage Class Reference

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

Public Types

enum  { IDENTIFIER = EMANE_CONTROL_MEASSGE_FREQUENCY }
 

Public Member Functions

FrequencyControlMessageclone () const override
 
 ~FrequencyControlMessage ()
 
const FrequencySegmentsgetFrequencySegments () const
 
std::uint64_t getBandwidthHz () const
 
ControlMessageId getId () const
 
virtual Serialization serialize () const
 

Static Public Member Functions

static FrequencyControlMessagecreate (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
u64BandwidthHzBandwidth in Hz
frequencySegmentsFrequency 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()


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