com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.options/RangeCalculationOptions

RangeCalculationOptions

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 (see com.tomtom.sdk.routing.range.RangeCalculator), that is, determining the boundary of the area reachable from an initial vehicle position given an energy, fuel, time, or distance budget.

Note: the parameter vehicle only supports vehicles that conform to the Motorized protocol.

Throws

if any of the parameters violates the requirements.

Constructors

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

Properties

Link copied to clipboard
val budgets: Set<Budget>

Budgets that limit the range. Only one budget is currently supported.

Link copied to clipboard
val costModel: CostModel? = null

Options governing which streets to prefer.

Link copied to clipboard
val departAt: Date? = null

Departure date and time.

Link copied to clipboard
val origin: ItineraryPoint

The starting location of the range.

Link copied to clipboard
val queryOptions: QueryOptions

Options regarding the way the request is sent to the server.

Link copied to clipboard
val routeToInclude: Route? = null

A route that must be included in the range up to the reachable offset. It is used to visually align the range boundary with the reachable offset on the currently navigated route, if there is one. It is recommended to pass the navigated route here if it is displayed simultaneously with the range.

Link copied to clipboard
val vehicle: Vehicle

The vehicle to be used. Only Motorized vehicles are supported. If the budget is Fuel or Energy, the vehicle's consumption must be set accordingly.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compares this object to another object.

Link copied to clipboard
open override fun hashCode(): Int

Calculates a hash value for this object.

Link copied to clipboard
open override fun toString(): String

Creates a string describing this object.

Inherited 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.