public
class
RoutingService
extends Object| java.lang.Object | |
| ↳ | com.carto.routing.RoutingService |
 Known Direct Subclasses
|
Class Overview
An abstract base class for routing services (either online or offline).
Summary
| 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
java.lang.Object
| |||||||||||
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
| Exception | If IO error occured during the route calculation. |
|---|---|
| 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
| Exception | If IO error occured during the route matching. |
|---|---|
| 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. |
|---|