Protocols
The following protocols are available globally.
-
Engine responsible for detecting arrival at the destination.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol ArrivalDetectionEngine : ManageableEngine
-
The DataSourceSelectionEngine provides an interface for the map data source.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol DataSourceSelectionEngine : ManageableEngine
-
Responsible for generation of
See moreGuidance
andLaneGuidance
related to upcoming road maneuvers.Declaration
Swift
public protocol GuidanceEngine : ManageableEngine
-
The protocol for a Guidance Instruction.
Contains a set of attributes common to all
GuidanceInstruction
s. It contains a set of default attributes common to allGuidanceInstruction
‘s.e.g., 'Turn right’, ‘Keep left’, ‘Take the ferry’, ‘Take the motorway’, ‘Arrive’.
Different types of
GuidanceInstruction
‘s will implement this, and may add extra attributes specific to theInstruction
type.e.g.,
See moreTurnInstruction
will containturnAngleInDegrees
andturnDirection
.Declaration
Swift
public protocol GuidanceInstruction
-
The LocationContextProviderEngine protocol provides functionality related to information about a matched location.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol LocationContextProviderEngine : ManageableEngine
-
The
ManageableEngine
protocol provides functionality related to engine data management.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol ManageableEngine
-
The MapMatchingEngine provides an interface for map matching functionality.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol MapMatchingEngine : ManageableEngine
-
The RouteProgressEngine protocol provides functionality related to the calculation of progress along the route.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol RouteProgressEngine : ManageableEngine
-
The RouteProjectionEngine is responsible for projecting the input route to obtain map references if they are not provided.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol RouteProjectionEngine : ManageableEngine
-
Selector responsible for choosing the routes according to protocol’s adoptee expectations
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol RouteProposalSelector
-
Engine responsible for replanning a route.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol RouteReplanningEngine
-
Responsible for detecting whether the
Route
s are being followed or deviated from.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol RouteTrackingEngine : ManageableEngine
-
Defines the interface to horizon elements.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol HorizonElement
-
Protocol that defines a horizon attribute data for onboard, online and hybrid implementations
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol HorizonAttributeData : AnyObject
-
Protocol that defines a horizon path osition for onboard, online and hybrid implementations
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol HorizonPathPosition
-
Defines the interface to the horizon engine. The horizon engine generates virtual horizon data based on the previously registered horizon options. These options define the length and the map data collected for the horizon paths. The client of the horizon engine can register multiple sets of horizon options. The client can also request the engine provide horizon data for all or some of the option sets. The client of the engine can also update the
HorizonOptions
by registering a new set of options or unregistering a previously registered set.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol HorizonEngine
-
Interface to the path search policy. The path search policy specifies whether the
HorizonEngine
must search along the entire route (seeRouteLengthPolicy
) or within an explicitly defined distance (seeExplicitDistancePolicy
).Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public protocol PathSearchDistancePolicy