gem::MarkerMatch Class Reference

Marker match. More...

Inheritance diagram for gem::MarkerMatch:

Collaboration diagram for gem::MarkerMatch:

Public Member Functions
	MarkerMatch ()=default
	Default constructor.
	MarkerMatch (const MarkerMatch &vm)
	Default copy constructor.
	MarkerMatch (MarkerMatch &&vm)=default
	Default move constructor noexcept is deduced.
MarkerMatch &	operator= (const MarkerMatch &vm)
	Default copy assignment.
MarkerMatch &	operator= (MarkerMatch &&marker)=default
	Default move assignment noexcept is deduced.
bool	operator== (const MarkerMatch &marker) const
	Comparison operator equal.
bool	operator!= (const MarkerMatch &marker) const
	Comparison operator not equal.
MarkerRef	getMarker () noexcept
	Get matched marker.
MarkerCollectionRef	getMarkerCollection () noexcept
	Get matched marker collection.
const MarkerCollectionRef	getMarkerCollection () const noexcept
	Get matched const marker collection.
const MarkerRef	getMarker () const noexcept
	Get matched marker.
int	getMarkerIndex () const noexcept
	Get matched marker index in marker collection.
int	getPartIndex () const noexcept
	Get matched marker part index in marker parts.
int	getSegment () const noexcept
	Get matched segment.
EMarkerMatchType	getType () const noexcept
	Get matched type.
int	getDistance () const noexcept
	Get distance to matched position in meters.
const CoordinatesRef	getCoordinates () const noexcept
	Get matched position coordinates.

Detailed Description

Marker match.

Implements share-read / share-write Api object over IMarkerMatch

Constructor & Destructor Documentation

MarkerMatch() [1/2]

gem::MarkerMatch::MarkerMatch ( const MarkerMatch & vm )

inline

Default copy constructor.

Parameters

[in]

vm

MarkerMatch

MarkerMatch() [2/2]

gem::MarkerMatch::MarkerMatch ( MarkerMatch && vm )

default

Default move constructor noexcept is deduced.

Parameters

vm	MarkerMatch

Member Function Documentation

getCoordinates()

const CoordinatesRef gem::MarkerMatch::getCoordinates ( ) const

inlinenoexcept

Get matched position coordinates.

Returns

Coordinates references

getDistance()

int gem::MarkerMatch::getDistance ( ) const

inlinenoexcept

Get distance to matched position in meters.

Returns

Distance in meters

getMarker() [1/2]

const MarkerRef gem::MarkerMatch::getMarker ( ) const

inlinenoexcept

Get matched marker.

Returns

Marker reference

getMarker() [2/2]

MarkerRef gem::MarkerMatch::getMarker ( )

inlinenoexcept

Get matched marker.

Returns

Marker reference

getMarkerCollection() [1/2]

const MarkerCollectionRef gem::MarkerMatch::getMarkerCollection ( ) const

inlinenoexcept

Get matched const marker collection.

Returns

MarkerCollection reference

getMarkerCollection() [2/2]

MarkerCollectionRef gem::MarkerMatch::getMarkerCollection ( )

inlinenoexcept

Get matched marker collection.

Returns

MarkerCollection reference

getMarkerIndex()

int gem::MarkerMatch::getMarkerIndex ( ) const

inlinenoexcept

Get matched marker index in marker collection.

Returns

Marker index

getPartIndex()

int gem::MarkerMatch::getPartIndex ( ) const

inlinenoexcept

Get matched marker part index in marker parts.

Returns

Marker part index

getSegment()

int gem::MarkerMatch::getSegment ( ) const

inlinenoexcept

Get matched segment.

Returns

Matched segment

getType()

EMarkerMatchType gem::MarkerMatch::getType ( ) const

inlinenoexcept

Get matched type.

See EMarkerMatchType

Returns

Matched type

operator!=()

bool gem::MarkerMatch::operator!= ( const MarkerMatch & marker ) const

inline

Comparison operator not equal.

Parameters

[in]

marker

MarkerMatch

Returns

true if not equal

operator=() [1/2]

MarkerMatch & gem::MarkerMatch::operator= ( const MarkerMatch & vm )

inline

Default copy assignment.

Parameters

[in]

vm

MarkerMatch

Returns

MarkerMatch reference

operator=() [2/2]

MarkerMatch & gem::MarkerMatch::operator= ( MarkerMatch && marker )

default

Default move assignment noexcept is deduced.

Parameters

marker

MarkerMatch

Returns

MarkerMatch reference

operator==()

bool gem::MarkerMatch::operator== ( const MarkerMatch & marker ) const

inline

Comparison operator equal.

Parameters

[in]

marker

MarkerMatch

Returns

true if equal