gem::OverlayItemPosition Class Reference

Coordinate referenced OverlayItem object. More...

Inheritance diagram for gem::OverlayItemPosition:

Collaboration diagram for gem::OverlayItemPosition:

Public Member Functions
	OverlayItemPosition (const OverlayItemPosition &item)=default
	Default copy constructor.
	OverlayItemPosition (OverlayItemPosition &&item)=default
	Default move constructor noexcept is deduced.
OverlayItemPosition &	operator= (const OverlayItemPosition &item)=default
	Default copy assignment.
OverlayItemPosition &	operator= (OverlayItemPosition &&item)=default
	Default move assignment noexcept is deduced.
const OverlayItemRef	getOverlayItem () const noexcept
	Get the OverlayItem object.
int	getDistance () const noexcept
	Get distance in meters from reference coordinates to the OverlayItem object.
int	getDeviation () const noexcept
	Get deviation in meters from reference coordinates to the OverlayItem object.

Detailed Description

Coordinate referenced OverlayItem object.

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

Constructor & Destructor Documentation

OverlayItemPosition() [1/2]

gem::OverlayItemPosition::OverlayItemPosition ( const OverlayItemPosition & item )

default

Default copy constructor.

Parameters

item	The OverlayItemPosition object to copy

OverlayItemPosition() [2/2]

gem::OverlayItemPosition::OverlayItemPosition ( OverlayItemPosition && item )

default

Default move constructor noexcept is deduced.

Parameters

item	The OverlayItemPosition object to move

Member Function Documentation

getDeviation()

int gem::OverlayItemPosition::getDeviation ( ) const

inlinenoexcept

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

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

Returns

Deviation in meters

getDistance()

int gem::OverlayItemPosition::getDistance ( ) const

inlinenoexcept

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

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

Returns

The distance in meters

getOverlayItem()

const OverlayItemRef gem::OverlayItemPosition::getOverlayItem ( ) const

inlinenoexcept

Get the OverlayItem object.

Returns

The OverlayItem object reference (read-only)

operator=() [1/2]

OverlayItemPosition & gem::OverlayItemPosition::operator= ( const OverlayItemPosition & item )

default

Default copy assignment.

Parameters

item	The OverlayItemPosition object to copy

Returns

The copied OverlayItemPosition object

operator=() [2/2]

OverlayItemPosition & gem::OverlayItemPosition::operator= ( OverlayItemPosition && item )

default

Default move assignment noexcept is deduced.

Parameters

item	The OverlayItemPosition object to move

Returns

The moved OverlayItemPosition object