gem::LandmarkPosition Class Reference

Coordinate referenced Landmark object. More...

Inheritance diagram for gem::LandmarkPosition:

Collaboration diagram for gem::LandmarkPosition:

Public Member Functions
	LandmarkPosition (const LandmarkPosition &lmk)=default
	Default copy constructor.
	LandmarkPosition (LandmarkPosition &&lmk)=default
	Default move constructor noexcept is deduced.
LandmarkPosition &	operator= (const LandmarkPosition &lmk)=default
	Default copy assignment.
LandmarkPosition &	operator= (LandmarkPosition &&lmk)=default
	Default move assignment noexcept is deduced.
const LandmarkRef	getLandmark () const noexcept
	Get the landmark object.
int	getDistance () const noexcept
	Get distance in meters from reference coordinates to the landmark object.
int	getDeviation () const noexcept
	Get deviation in meters from reference coordinates to the landmark object.

Detailed Description

Coordinate referenced Landmark object.

Implements share-read / copy-on-write Api object over ILandmarkPosition.

Constructor & Destructor Documentation

LandmarkPosition() [1/2]

gem::LandmarkPosition::LandmarkPosition ( const LandmarkPosition & lmk )

default

Default copy constructor.

Parameters

lmk	LandmarkPosition object to copy from

LandmarkPosition() [2/2]

gem::LandmarkPosition::LandmarkPosition ( LandmarkPosition && lmk )

default

Default move constructor noexcept is deduced.

Parameters

lmk	LandmarkPosition object to move from

Member Function Documentation

getDeviation()

int gem::LandmarkPosition::getDeviation ( ) const

inlinenoexcept

Get deviation in meters from reference coordinates to the landmark object.

The deviation is equal with distance except when the landmark is related to a route (e.g. an alarm along route) in which case is calculated as a straight line distance between the landmark and the closest point on the route

Returns

Deviation in meters

getDistance()

int gem::LandmarkPosition::getDistance ( ) const

inlinenoexcept

Get distance in meters from reference coordinates to the landmark object.

The distance is calculated as a straight line distance between two coordinates except when the landmark is related to a route (e.g. an alarm along route) in which case the distance is calculated along the route

Returns

Distance in meters

getLandmark()

const LandmarkRef gem::LandmarkPosition::getLandmark ( ) const

inlinenoexcept

Get the landmark object.

Returns

LandmarkRef for the landmark object ( read only )

operator=() [1/2]

LandmarkPosition & gem::LandmarkPosition::operator= ( const LandmarkPosition & lmk )

default

Default copy assignment.

Parameters

lmk	LandmarkPosition object to copy from

Returns

reference to this object

operator=() [2/2]

LandmarkPosition & gem::LandmarkPosition::operator= ( LandmarkPosition && lmk )

default

Default move assignment noexcept is deduced.

Parameters

lmk	LandmarkPosition object to move from

Returns

reference to this object