| java.lang.Object | ||
| ↳ | com.carto.routing.RoutingService | |
| ↳ | com.carto.routing.OSRMOfflineRoutingService | |
Class Overview
An offline routing service that uses Carto-specific routing
database file created from OSRM prepared routing files.
Note: this class is experimental and may change or even be removed in future SDK versions.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
OSRMOfflineRoutingService(String path)
Constructs a new OSRMOfflineRoutingService instance given database file.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| RoutingResult |
calculateRoute(RoutingRequest request)
Calculates routing result (path) based on routing request.
| ||||||||||
| synchronized void | delete() | ||||||||||
| String |
getProfile()
Returns the current routing profile.
| ||||||||||
| RouteMatchingResult |
matchRoute(RouteMatchingRequest request)
Matches specified points to the points on the road network.
| ||||||||||
| void |
setProfile(String profile)
Sets the current routing profile.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.carto.routing.RoutingService
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public OSRMOfflineRoutingService (String path)
Constructs a new OSRMOfflineRoutingService instance given database file.
Parameters
| path | The full path to the database file. |
|---|
Throws
| Exception | If the database file could not be opened or read. |
|---|---|
| IOException |
Public Methods
public RoutingResult calculateRoute (RoutingRequest request)
Calculates routing result (path) based on routing request.
Parameters
| request | The routing request defining via points. |
|---|
Returns
- The result or null if routing failed.
Throws
| IOException |
|---|
public synchronized void delete ()
public String getProfile ()
Returns the current routing profile.
Returns
- The current routing profile.
public RouteMatchingResult matchRoute (RouteMatchingRequest request)
Matches specified points to the points on the road network.
Parameters
| request | The matching request defining points. |
|---|
Returns
- The matching result or null if route matching failed.
Throws
| IOException |
|---|
public void setProfile (String profile)
Sets the current routing profile.
Parameters
| profile | The new routing profile. Routing profiles are dependent on specific routing service. |
|---|