routing:routing-client-api/com.tomtom.sdk.routing.api

Package com.tomtom.sdk.routing.api

Types

interface CalculateRangeCallback : Callback<CalculateRangeResult, RoutingError>

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: DepartAt? = null, val maxFerryLength: Distance? = null, val chargeMargins: Set<Energy> = emptySet(), val queryOptions: QueryOptions? = null)

Options for range calculation.

CalculateRangeResult

data class CalculateRangeResult(val range: Range)

Represents the calculated range based on a passed CalculateRangeOptions.

InvalidRoutingOptions

class InvalidRoutingOptions(val message: String? = null) : RoutingError

Raised when invalid arguments were passed to a routing function.

Itinerary

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

Itinerary represents a sequence of points that a route visits.

ItineraryPoint

data class ItineraryPoint(val place: Place)

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

ItineraryPointId

@JvmInline

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

Represents a unique identifier of an itinerary point.

PlanRouteCallback

interface PlanRouteCallback : Callback<PlanRouteResult, RoutingError>

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

PlanRouteOptions

data class PlanRouteOptions( val itinerary: Itinerary, val departAt: Date? = null, val routeType: RouteType = RouteType.FAST, val considerTraffic: Boolean = true, val avoidTypes: List<AvoidType> = arrayListOf(), val travelMode: TravelMode = TravelMode.CAR, val hilliness: Hilliness? = null, val windingness: Windingness? = null, val maxAlternatives: Int = 0, val alternativeType: AlternativeType? = null, val minDeviationDistance: Int? = null, val minDeviationTime: Int? = null, val instructionType: InstructionType = InstructionType.NONE, val language: Locale? = null, val routeRepresentation: RouteRepresentation = RouteRepresentation.POLYLINE, val includeExtendedRouteRepresentation: Boolean = true, val computeTravelTimeFor: ComputeTravelTimeFor = ComputeTravelTimeFor.NONE, val vehicleHeading: Int? = null, val sectionTypes: List<SectionType> = mutableListOf(SectionType.TRAVEL_MODE), val arriveAt: Date? = null, val supportingPoints: List<List<GeoCoordinate>> = arrayListOf(), val avoidVignettes: List<String>? = null, val allowVignettes: List<String>? = null, val avoidAreas: List<GeoBoundingBox>? = null, val reportType: ReportType = ReportType.NONE, val vehicle: Vehicle? = null, val instructionAnnouncementPoints: AnnouncementPoints = AnnouncementPoints.NONE, val instructionPhonetics: InstructionPhoneticsType = InstructionPhoneticsType.NONE, val instructionRoadShieldReferences: RoadShieldReferences = RoadShieldReferences.NONE, val trackingId: String? = null, val coordinatePrecision: CoordinatePrecision = CoordinatePrecision.FULL, val extras: Any? = null)

Represents parameters used in a Routing API Request.

PlanRouteResult

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

Represents the calculated route based on a passed PlanRouteOptions.

RoutingApi

interface RoutingApi : Disposable

Entry point to perform a route planning action.

RoutingError

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

Represents an error raised when something went wrong in routing.