-
- All Implemented Interfaces:
public interface DirectionClient
Client that exposes the functions to create supported requests in Direction Service Service. To get DirectionClient instance, use DirectionClient.Factory.createInstance(SDKOptions options)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
DirectionClient.Factory
Factory class that creates DirectionClient instances.
-
Method Summary
Modifier and Type Method Description abstract Task<IsochroneResponse>
createIsochroneTask(@NonNull() IsochroneRequest request, @NonNull() RequestMode mode)
Create a task for Isochrone calculation based on specified request mode. abstract Task<IsochroneResponse>
createIsochroneTask(@NonNull() IsochroneRequest request)
Create a task for Isochrone calculation using default hybrid approach. abstract Task<IsochroneResponse>
createEvIsochroneTask(@NonNull() EvIsochroneRequest request)
Create a task for Isochrone calculation based on the remaining battery power of the current vehicle An isochrone, from Greek root word iso (equal) and chrone (time), is a line that connects points of equal travel time or distance around a given location. abstract Task<WaypointOptimizeResponse>
createWaypointOptimizeTask(@NonNull() WaypointOptimizeRequest request, @NonNull() RequestMode mode)
Create a task for waypoint order optimization. abstract Task<WaypointOptimizeResponse>
createWaypointOptimizeTask(@NonNull() WaypointOptimizeRequest request)
Create a task for waypoint order optimization using default hybrid approach. abstract void
dispose()
Clean up memory and cache usage for Direction Client, this will also terminate onboard routing engine. -
-
Method Detail
-
createIsochroneTask
abstract Task<IsochroneResponse> createIsochroneTask(@NonNull() IsochroneRequest request, @NonNull() RequestMode mode)
Create a task for Isochrone calculation based on specified request mode.
An isochrone, from Greek root word iso (equal) and chrone (time), is a line that connects points of equal travel time or distance around a given location. The Isochrone task will computes the area that is reachable within a specified time (currently not supported) or distance from a location and returns it as a list of geometrical points.
- Parameters:
request
- java/kt IsochroneRequest object IsochroneRequest.mode
- whether the request will be sent to cloud, onboard or hybrid mode.
-
createIsochroneTask
abstract Task<IsochroneResponse> createIsochroneTask(@NonNull() IsochroneRequest request)
Create a task for Isochrone calculation using default hybrid approach.
- Parameters:
request
- java/kt IsochroneRequest object IsochroneRequest.
-
createEvIsochroneTask
abstract Task<IsochroneResponse> createEvIsochroneTask(@NonNull() EvIsochroneRequest request)
Create a task for Isochrone calculation based on the remaining battery power of the current vehicle An isochrone, from Greek root word iso (equal) and chrone (time), is a line that connects points of equal travel time or distance around a given location. The Isochrone task will computes the area that is reachable within a specified time (currently not supported) or distance from a location and returns it as a list of geometrical points.
- Parameters:
request
- EvIsochroneRequest.
-
createWaypointOptimizeTask
abstract Task<WaypointOptimizeResponse> createWaypointOptimizeTask(@NonNull() WaypointOptimizeRequest request, @NonNull() RequestMode mode)
Create a task for waypoint order optimization.
Waypoint optimization will not really calculate route or even check if the provided location is navigable. So it can't guarantee the optimized location sequence can be used to generate a valid route. This may be improved later.
- Parameters:
request
- java/kt WaypointOptimizeRequest object WaypointOptimizeRequest.mode
- whether the request will be sent to cloud, onboard or hybrid mode.
-
createWaypointOptimizeTask
abstract Task<WaypointOptimizeResponse> createWaypointOptimizeTask(@NonNull() WaypointOptimizeRequest request)
Create a task for waypoint order optimization using default hybrid approach.
- Parameters:
request
- java/kt WaypointOptimizeRequest object WaypointOptimizeRequest.
-
dispose
abstract void dispose()
Clean up memory and cache usage for Direction Client, this will also terminate onboard routing engine.
-
-
-
-