EMANE  1.2.1
EMANE::Events::CommEffectEvent Class Reference

Comm Effect events are used to set asynchronous link characteristics from one or more transmitting NEMs to the receiving NEM. More...

#include <commeffectevent.h>

Inheritance diagram for EMANE::Events::CommEffectEvent:
EMANE::Event EMANE::Serializable

Public Types

enum  { IDENTIFIER = EMANE_EVENT_COMMEFFECT }
 

Public Member Functions

 CommEffectEvent (const Serialization &serialization)
 
 CommEffectEvent (const CommEffects &commEffects)
 
 CommEffectEvent (const CommEffectEvent &rhs)
 
CommEffectEventoperator= (const CommEffectEvent &rhs)
 
 CommEffectEvent (CommEffectEvent &&rval)
 
CommEffectEventoperator= (CommEffectEvent &&rval)
 
 ~CommEffectEvent ()
 
Serialization serialize () const override
 
const CommEffectsgetCommEffects () const
 
EventId getEventId () const
 

Detailed Description

Comm Effect events are used to set asynchronous link characteristics from one or more transmitting NEMs to the receiving NEM.

Definition at line 53 of file commeffectevent.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
IDENTIFIER 

Definition at line 120 of file commeffectevent.h.

Constructor & Destructor Documentation

◆ CommEffectEvent() [1/4]

EMANE::Events::CommEffectEvent::CommEffectEvent ( const Serialization serialization)

Creates a CommEffectEvent instance from a serialization

Parameters
serializationMessage serialization
Exceptions
SerializationExceptionwhen a valid message cannot be de-serialized

Definition at line 52 of file commeffectevent.cc.

◆ CommEffectEvent() [2/4]

EMANE::Events::CommEffectEvent::CommEffectEvent ( const CommEffects commEffects)

Creates a CommEffectEvent instance

Parameters
commEffectsComm Effect link characteristics

Definition at line 79 of file commeffectevent.cc.

◆ CommEffectEvent() [3/4]

EMANE::Events::CommEffectEvent::CommEffectEvent ( const CommEffectEvent rhs)

Creates a CommEffectEvent by copy

Parameters
rhsInstance to copy

Definition at line 83 of file commeffectevent.cc.

◆ CommEffectEvent() [4/4]

EMANE::Events::CommEffectEvent::CommEffectEvent ( CommEffectEvent &&  rval)

Creates a CommEffectEvent by moving

Parameters
rvalInstance to move

Definition at line 93 of file commeffectevent.cc.

◆ ~CommEffectEvent()

EMANE::Events::CommEffectEvent::~CommEffectEvent ( )

Destroys an instance

Definition at line 107 of file commeffectevent.cc.

Member Function Documentation

◆ getCommEffects()

const EMANE::Events::CommEffects & EMANE::Events::CommEffectEvent::getCommEffects ( ) const

Gets the Comm Effect link characteristics

Returns
comm effects

Definition at line 110 of file commeffectevent.cc.

◆ getEventId()

EventId EMANE::Event::getEventId ( ) const
inlineinherited

Gets the event id

Returns
event id

Definition at line 59 of file event.h.

◆ operator=() [1/2]

EMANE::Events::CommEffectEvent & EMANE::Events::CommEffectEvent::operator= ( const CommEffectEvent rhs)

Sets a CommEffectEvent by copy

Parameters
rhsInstance to copy

Definition at line 87 of file commeffectevent.cc.

◆ operator=() [2/2]

EMANE::Events::CommEffectEvent & EMANE::Events::CommEffectEvent::operator= ( CommEffectEvent &&  rval)

Sets a CommEffectEvent by moving

Parameters
rvalInstance to moving

Definition at line 101 of file commeffectevent.cc.

◆ serialize()

EMANE::Serialization EMANE::Events::CommEffectEvent::serialize ( ) const
overridevirtual

Serializes the instance

Exceptions
SerializationExceptionif the instance cannot be serialized

Reimplemented from EMANE::Serializable.

Definition at line 115 of file commeffectevent.cc.


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