Package-level declarations

Types

Link copied to clipboard
class ChargingOptions(val minChargeAtDestination: Energy, val minChargeAtChargingStops: Energy, val avoidChargingParks: List<UUID> = emptyList(), val chargingStopsStrategy: ChargingStopsStrategy = ChargingStopsStrategy.AutomaticFastest)

Represents the electric vehicle options that provide charging information.

Link copied to clipboard

ChargingStopsStrategy Specifies the charging stops strategy to be used by the Online Routing service.

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
data class ItineraryPoint(val place: Place, val heading: Angle? = null)

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

Link copied to clipboard
value class ItineraryPointId(val value: UUID = UUID.randomUUID())

Represents a unique identifier of an itinerary point.

Link copied to clipboard
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, that is, determining the boundary of the area reachable from an initial vehicle position given some budget such as limited energy.

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.

Functions

Link copied to clipboard
fun RangeCalculationOptions.copy(origin: ItineraryPoint = this.origin, budgets: Set<Budget> = this.budgets, vehicle: Vehicle = this.vehicle, costModel: CostModel? = this.costModel, departAt: Date? = this.departAt, routeToInclude: Route? = this.routeToInclude, queryOptions: QueryOptions = this.queryOptions): RangeCalculationOptions

Copies this object while allowing to change some properties.