Package-level declarations
Types
Link copied to clipboard
data class ChargingOptions(val minChargeAtDestination: Energy = Energy.kilowattHours(0), val minChargeAtChargingStops: Energy = Energy.kilowattHours(0), val avoidChargingParks: List<UUID> = emptyList())
Represents the electric vehicle options that provide charging information.
Link copied to clipboard
data class Itinerary(val origin: ItineraryPoint, val destination: ItineraryPoint, val waypoints: List<ItineraryPoint> = emptyList())
Itinerary represents a sequence of points that a route visits.
Link copied to clipboard
Encapsulates Place with the additional information relevant for the route itinerary.
Link copied to clipboard
Represents a unique identifier of an itinerary point.
Link copied to clipboard
data class RangeCalculationOptions(val origin: ItineraryPoint, val budgets: Set<Budget>, val vehicle: Vehicle = Vehicle.Car(), val costModel: CostModel? = null, val departAt: Date? = null, val routeToInclude: Route? = null, val queryOptions: QueryOptions = QueryOptions())
Options for range calculation.
Link copied to clipboard
RouteInformationMode defines how much guidance information (instructions, lane guidance and junction views) is returned with the route.
Link copied to clipboard
data class RouteLegOptions(val supportingPoints: List<GeoPoint>, val chargingInformation: ChargingInformation? = null)
Options specific for concrete leg.
Link copied to clipboard
data class RoutePlanningOptions(val itinerary: Itinerary, val costModel: CostModel? = CostModel(), val departAt: Date? = null, val arriveAt: Date? = null, val alternativeRoutesOptions: AlternativeRoutesOptions? = null, val guidanceOptions: GuidanceOptions? = null, val routeLegOptions: List<RouteLegOptions> = emptyList(), val vehicle: Vehicle = Vehicle.Car(), val chargingOptions: ChargingOptions? = null, val queryOptions: QueryOptions? = null, val waypointOptimization: WaypointOptimization? = null, val mode: RouteInformationMode = RouteInformationMode.Complete, val arrivalSidePreference: ArrivalSidePreference = ArrivalSidePreference.AnySide)
Options for route planning.