gem::CoordinatesReferenceList< ItemType > Class Template Reference

CoordinatesReferenceList object. More...

Inheritance diagram for gem::CoordinatesReferenceList< ItemType >:

Collaboration diagram for gem::CoordinatesReferenceList< ItemType >:

Public Member Functions
Coordinates	getReferenceCoordinates () const noexcept
	Get reference coordinates.
const ApiRef< List< ItemType > >	getItems () const noexcept
	Get the items list.
int	size () const noexcept
	Get the number of items.
const ApiRef< typename ItemType::BaseObject >	getItem (int index) const noexcept
	Get the specified item by index;.
int	getDistance (int index) const noexcept
	Get the distance in meters from the item to the reference coordinate.
int	getDeviation (int index) const noexcept
	Get the deviation in meters from the item to the expected reference coordinate trajectory ( e.g.

Detailed Description

template<typename ItemType>
class gem::CoordinatesReferenceList< ItemType >

CoordinatesReferenceList object.

Implements share-read / write Api object over ICoordinatesReferenceList.

Member Function Documentation

getDeviation()

template<typename ItemType>

int gem::CoordinatesReferenceList< ItemType >::getDeviation ( int index ) const

inlinenoexcept

Get the deviation in meters from the item to the expected reference coordinate trajectory ( e.g.

route, track )

Parameters

[in]

index

Index of the item.

Returns

deviation of the item specified by index, or 0 if the index is not in range 0 to (size()-1).

If the reference coordinate does not have an associated trajectory, the deviation will be equal to the distance.

getDistance()

template<typename ItemType>

int gem::CoordinatesReferenceList< ItemType >::getDistance ( int index ) const

inlinenoexcept

Get the distance in meters from the item to the reference coordinate.

Parameters

[in]

index

Index of the item.

Returns

distance to the item specified by index, or 0 if the index is not in range 0 to (size()-1).

getItem()

template<typename ItemType>

const ApiRef< typename ItemType::BaseObject > gem::CoordinatesReferenceList< ItemType >::getItem ( int index ) const

inlinenoexcept

Get the specified item by index;.

Parameters

[in]

index

Index of the item.

Returns

API object representing the item, or default object if the index is not in range 0 to (size()-1).

getItems()

template<typename ItemType>

const ApiRef< List< ItemType > > gem::CoordinatesReferenceList< ItemType >::getItems ( ) const

inlinenoexcept

Get the items list.

Returns

A constant ApiRef to a List containing items of ItemType.

getReferenceCoordinates()

template<typename ItemType>

Coordinates gem::CoordinatesReferenceList< ItemType >::getReferenceCoordinates ( ) const

inlinenoexcept

Get reference coordinates.

Returns

A Coordinates object containing the latitude and longitude values of the reference coordinates.

size()

template<typename ItemType>

int gem::CoordinatesReferenceList< ItemType >::size ( ) const

inlinenoexcept

Get the number of items.

Returns

The number of items in the list as an integer. If the list is empty, the returned value will be zero.