Package com.tomtom.sdk.routing.api

Types

Callback which is responsible to inform about a received CalculateRangeResult or respective error.

data class CalculateRangeOptions( val origin: ItineraryPoint, val budget: Budget, val vehicle: Vehicle, val costModel: CostModel? = null, val departAt: Date? = null, val maxFerryLength: Distance? = null, val chargeMargins: Set<Energy> = emptySet(), val queryOptions: QueryOptions? = null)

Options for range calculation.

Represents the calculated range based on a passed CalculateRangeOptions.

class Itinerary( val origin: ItineraryPoint, val destination: ItineraryPoint, val waypoints: List<ItineraryPoint> = emptyList())

Itinerary represents a sequence of points that a route visits.

data class ItineraryPoint(val place: Place, val heading: Angle? = null)

Encapsulates Place with the additional information relevant for the route itinerary.

value class ItineraryPointId(val value: UUID = UUID.randomUUID())

Represents a unique identifier of an itinerary point.

Callback which is responsible to inform about a received PlanRouteResult or respective error.

data class PlanRouteOptions( val itinerary: Itinerary, val costModel: CostModel? = null, val departAt: Date? = null, val arriveAt: Date? = null, val alternativeRoutesOptions: AlternativeRoutesOptions? = null, val guidanceOptions: GuidanceOptions? = null, val routeLegOptions: List<RouteLegOptions> = arrayListOf(), val vehicle: Vehicle = Vehicle(), val queryOptions: QueryOptions? = null)

Options for route planning.

data class PlanRouteResult(val routes: List<Route>)

Represents the calculated route based on a passed PlanRouteOptions.

data class RouteLegOptions(val supportingPoints: List<GeoCoordinate>)

Options specific for concrete leg.

Entry point to perform a route planning action.

open class RoutingError(val message: String? = null) : RuntimeException

Represents an error raised when something went wrong in routing.