Router

open class Router : NativeMethodsReceiver

Contains classes, protocols, and enumerations for describing and calculating routes.

Types

EVRangeListener

interface EVRangeListener

RecomputeType

@Retention(value = RetentionPolicy.CLASS)

annotation class RecomputeType

RouteComputeAdapter

abstract class RouteComputeAdapter : Router.RouteComputeListener

Listener adapter for RouteComputeListener

RouteComputeError

@Retention(value = RetentionPolicy.CLASS)

annotation class RouteComputeError

Routing error types.

RouteComputeListener

interface RouteComputeListener : NativeMethodsReceiver.NativeListener

Represents a listener to handle route calculation updates.

RouteDurationListener

interface RouteDurationListener : NativeMethodsReceiver.NativeListener

Functions

calculateEVRange

open fun calculateEVRange(position: GeoCoordinates, capacities: List<Double>, options: RoutingOptions, profile: EVProfile, listener: Router.EVRangeListener)

This method will compute routes in all directions from the position, and returns a polygon of where you can go with your battery capacity.You can get multiple polygons for different capacities in one call.

open fun calculateEVRange(position: GeoCoordinates, capacities: List<Double>, options: RoutingOptions, profile: EVProfile, listener: Router.EVRangeListener, @Nullable() executor: Executor)

This method will compute routes in all direction f rom position, and returs polygon area where you can go with your battery capacity.You can get multiple polygons for different capacities in one call.

cancelCompute

open fun cancelCompute()

Cancels a computed route or cancel current computing.

computeAETRRoute

open fun computeAETRRoute(routePlan: RoutePlan, @NonNull() profile: AETRProfile, listener: Router.RouteComputeListener)

Deprecated - use computeRoute with RouteRequest

open fun computeAETRRoute(routePlan: RoutePlan, @NonNull() profile: AETRProfile, listener: Router.RouteComputeListener, @Nullable() executor: Executor)

Deprecated - use computeRoute with RouteRequest

computeEVRoute

open fun computeEVRoute(routePlan: RoutePlan, @NonNull() profile: EVProfile, listener: Router.RouteComputeListener)

Deprecated - use computeRoute with RouteRequest

open fun computeEVRoute(routePlan: RoutePlan, @NonNull() profile: EVProfile, @NonNull() preference: EVPreferences, listener: Router.RouteComputeListener)

Deprecated - use computeRoute with RouteRequest

open fun computeEVRoute(routePlan: RoutePlan, @NonNull() profile: EVProfile, listener: Router.RouteComputeListener, @Nullable() executor: Executor)

Deprecated - use computeRoute with RouteRequest

open fun computeEVRoute(routePlan: RoutePlan, @NonNull() profile: EVProfile, @NonNull() preference: EVPreferences, listener: Router.RouteComputeListener, @Nullable() executor: Executor)

Deprecated - use computeRoute with RouteRequest

computeGuidedRoute

open fun computeGuidedRoute(@NonNull() profile: GuidedRouteProfile, @NonNull() listener: Router.RouteComputeListener)

Deprecated - use computeRoute with RouteRequest

open fun computeGuidedRoute(@NonNull() profile: GuidedRouteProfile, @NonNull() listener: Router.RouteComputeListener, @Nullable() executor: Executor)

Deprecated - use computeRoute with RouteRequest

computeNextDurations

open fun computeNextDurations(route: Route, times: List<Long>, listener: Router.RouteDurationListener)

Compute the durations of a route in any given time(s).Note that the speed profiles change each 15 minutes so it's ineffective to request smaller intervals.

open fun computeNextDurations(route: Route, times: List<Long>, listener: Router.RouteDurationListener, @Nullable() executor: Executor)

Compute the duration of a route in any given time(s).Note that the speed profiles change each 15 minutes so it's ineffective to request smaller intervals.

computeRoute

open fun computeRoute(routePlan: RoutePlan, listener: Router.RouteComputeListener)

This method will compute a full route.

open fun computeRoute(@NonNull() routeRequest: RouteRequest, @NonNull() listener: Router.RouteComputeListener)

open fun computeRoute(@NonNull() routeRequest: RouteRequest, listener: Router.RouteComputeListener, @Nullable() executor: Executor)

open fun computeRoute(routePlan: RoutePlan, listener: Router.RouteComputeListener, @Nullable() executor: Executor)

This method will compute a full route.

computeRouteFromJSONString

open fun computeRouteFromJSONString(json: String, listener: Router.RouteComputeListener)

Calculates route from JSON string that was serialized via serializeToBriefJSON

open fun computeRouteFromJSONString(json: String, listener: Router.RouteComputeListener, @Nullable() executor: Executor)

Calculates route from JSON string that was serialized via serializeToBriefJSON

createBriefJSONFromITF

open fun createBriefJSONFromITF(filePath: String): String

Creates a brief JSON from ITF file

createRoutePlanFromJSONString

open fun createRoutePlanFromJSONString(json: String): List<Waypoint>

Creates a list of Waypoints from JSON that was serialized via serializeToBriefJSON Deprecated - use createRouteRequestFromJSONString

createRouteRequestFromJSONString

open fun createRouteRequestFromJSONString(@NonNull() json: String, @NonNull() listener: OnRouteRequestDeserialized)

Creates RouteRequest from JSON that was serialized via serializeToBriefJSON

open fun createRouteRequestFromJSONString(@NonNull() json: String, @NonNull() listener: OnRouteRequestDeserialized, @Nullable() executor: Executor)

Creates RouteRequest from JSON that was serialized via serializeToBriefJSON

destroy

open fun destroy()

getChargingWaypoints

open fun getChargingWaypoints(route: Route): List<ChargingWaypoint>

getRemainingBatteryCapacityAt

open fun getRemainingBatteryCapacityAt(waypoint: Waypoint, profile: EVProfile, route: Route): Float

Calculates remaining battery capacity (kwh) at given waypoint at route based on starting ev profile