.. _pilot.MapMatch:

pilot.MapMatch
==============

.. cpp:namespace:: pilot::MapMatch

Class
-----

`MapMatch` describes the current position in terms of the :ref:`RoadMap`, when possible.

Inherits from :ref:`pilot.Sample`.


Fields
------

.. cpp:member:: bool is_valid

	If a match was found or not.
	
.. cpp:member:: float distance

	Shortest distance from platform center to matched node or segment in [meters].
	
.. cpp:member:: MapNode* node
	
	The matched :ref:`pilot.MapNode` if near a node.

.. cpp:member:: RoadSegment* segment

	The matched :ref:`pilot.RoadSegment` if on a segment, which is normally the case.