EMANE  1.0.1
EMANE::Events::Location Class Reference

A location entry holds an NEM Id, that NEM's position information and optional orientation and velocity. More...

#include <location.h>

Public Member Functions

 Location (NEMId id, const Position &position, std::pair< const Orientation &, bool > orientation, std::pair< const Velocity &, bool > velocity)
 
NEMId getNEMId () const
 
const PositiongetPosition () const
 
std::pair< const Orientation &, bool > getOrientation () const
 
std::pair< const Velocity &, bool > getVelocity () const
 

Detailed Description

A location entry holds an NEM Id, that NEM's position information and optional orientation and velocity.

See also
Position
Orientation
Velocity
Note
Instances are immutable

Definition at line 61 of file location.h.

Constructor & Destructor Documentation

◆ Location()

EMANE::Events::Location::Location ( NEMId  id,
const Position position,
std::pair< const Orientation &, bool >  orientation,
std::pair< const Velocity &, bool >  velocity 
)
inline

Definition at line 35 of file location.inl.

Member Function Documentation

◆ getNEMId()

EMANE::NEMId EMANE::Events::Location::getNEMId ( ) const
inline

Gets the NEM Id

Returns
NEM Id

Definition at line 47 of file location.inl.

◆ getOrientation()

std::pair< const EMANE::Orientation &, bool > EMANE::Events::Location::getOrientation ( ) const
inline

Gets the optional NEM orientation

Returns
std::pair, where first is the orientation and second is a flag indicating whether it is valid (present)

Definition at line 60 of file location.inl.

◆ getPosition()

const EMANE::Position & EMANE::Events::Location::getPosition ( ) const
inline

Gets the NEM position

Returns
position

Definition at line 53 of file location.inl.

◆ getVelocity()

std::pair< const EMANE::Velocity &, bool > EMANE::Events::Location::getVelocity ( ) const
inline

Gets the optional NEM velocity

Returns
std::pair, where first is the velocity and second is a flag indicating whether it is valid (present)

Definition at line 67 of file location.inl.


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