Package 

Interface DirectionClient

  • 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)

    • Constructor Detail

    • Method Detail

      • createIsochroneTask

         abstract Task<IsochroneResponse> createIsochroneTask(@NonNull() IsochroneRequest request, @NonNull() Object 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.

      • 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() Object 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.

      • dispose

         abstract void dispose()

        Clean up memory and cache usage for Direction Client, this will also terminate onboard routing engine.