TomTom SDK for iOS RangeCalculationOptions

RangeCalculationOptions

public struct RangeCalculationOptions

Options for range calculation.

Important

This is a Public Preview API. It may be changed or removed at any time.

  • Creates a new RangeCalculationOptions instance.

    Throws

    RoutingOptionsError if any of the parameters violates its requirements.

    Declaration

    Swift

    public init
    (
        origin: ItineraryPoint,
        budgets: Set<Budget>,
        vehicle: any Vehicle = Car(),
        costModel: CostModel? = nil,
        departAt: Date? = nil,
        routeToInclude: Route? = nil,
        queryOptions: QueryOptions? = nil
    ) throws

    Parameters

    origin

    The starting location of the range.
    budgets

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

    The vehicle to be used. Only Motorized vehicles are supported. If the budget is Budget.fuel or Budget.energy, the vehicle’s consumption must be set accordingly.
    costModel

    Options governing which paths to prefer.
    departAt

    A departure time for the route.
    routeToInclude

    A route that, up to its reachable offset, should be contained in the range.
    queryOptions

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

  • The starting location of the range.

    Declaration

    Swift

    public var origin: ItineraryPoint

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

    Declaration

    Swift

    public var budgets: Set<Budget>

  • The vehicle to be used. Only Motorized vehicles are supported. If the budget is Budget.fuel or Budget.energy, the vehicle’s consumption must be set accordingly.

    Declaration

    Swift

    public var vehicle: any Vehicle

  • Options governing which paths to prefer.

    Declaration

    Swift

    public var costModel: CostModel?

  • A departure time for the route.

    Declaration

    Swift

    public var departAt: Date?

  • A route that, up to its reachable offset, should be contained in the range.

    Declaration

    Swift

    public var routeToInclude: Route?

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

    Declaration

    Swift

    public var queryOptions: QueryOptions?