EMANE  1.2.1
EMANE::Events::LocationEvent Class Reference

A location event is usd to set the position, orientation and velocity information for one or more NEMs. More...

#include <locationevent.h>

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

Public Types

enum  { IDENTIFIER = EMANE_EVENT_LOCATION }
 

Public Member Functions

 LocationEvent (const Serialization &serialization)
 
 LocationEvent (const Locations &locations)
 
 LocationEvent (const LocationEvent &rhs)
 
LocationEventoperator= (const LocationEvent &rhs)
 
 LocationEvent (LocationEvent &&rval)
 
LocationEventoperator= (LocationEvent &&rval)
 
 ~LocationEvent ()
 
Serialization serialize () const override
 
const LocationsgetLocations () const
 
EventId getEventId () const
 

Detailed Description

A location event is usd to set the position, orientation and velocity information for one or more NEMs.

Definition at line 52 of file locationevent.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
IDENTIFIER 

Definition at line 118 of file locationevent.h.

Constructor & Destructor Documentation

◆ LocationEvent() [1/4]

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

Creates a LocationEvent instance from a serialization

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

Definition at line 52 of file locationevent.cc.

◆ LocationEvent() [2/4]

EMANE::Events::LocationEvent::LocationEvent ( const Locations locations)

Creates a LocationEvent instance

Parameters
locationsOne or more Location instances

Definition at line 106 of file locationevent.cc.

◆ LocationEvent() [3/4]

EMANE::Events::LocationEvent::LocationEvent ( const LocationEvent rhs)

Creates a LocationEvent by copy

Parameters
rhsInstance to copy

Definition at line 110 of file locationevent.cc.

◆ LocationEvent() [4/4]

EMANE::Events::LocationEvent::LocationEvent ( LocationEvent &&  rval)

Creates a LocationEvent by moving

Parameters
rvalInstance to move

Definition at line 120 of file locationevent.cc.

◆ ~LocationEvent()

EMANE::Events::LocationEvent::~LocationEvent ( )

Destroys an instance

Definition at line 133 of file locationevent.cc.

Member Function Documentation

◆ getEventId()

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

Gets the event id

Returns
event id

Definition at line 59 of file event.h.

◆ getLocations()

const EMANE::Events::Locations & EMANE::Events::LocationEvent::getLocations ( ) const

Gets the location entries

Returns
location entries

Definition at line 135 of file locationevent.cc.

◆ operator=() [1/2]

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

Sets a LocationEvent by copy

Parameters
rhsInstance to copy

Definition at line 114 of file locationevent.cc.

◆ operator=() [2/2]

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

Sets a LocationEvent by moving

Parameters
rvalInstance to move

Definition at line 127 of file locationevent.cc.

◆ serialize()

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

Serializes the instance

Exceptions
SerializationExceptionif the instance cannot be serialized

Reimplemented from EMANE::Serializable.

Definition at line 140 of file locationevent.cc.


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