RangeCalculationOptions

public struct RangeCalculationOptions

Options for range calculation.

Important

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

Lifecycle

  • Declaration

    Swift

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

    Parameters

    origin

    The starting location of the range.
    budgets

    Budgets that limit the range. All budgets must be of the same type.
    costModel

    Options governing which paths to prefer.
    departAt

    A departure time for the route.
    routeToInclude

    A polyline that must be fully included in the range.
    vehicle

    The vehicle dimensions, restrictions and engine parameters.
    queryOptions

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

Public

  • The starting location of the range.

    Declaration

    Swift

    public let origin: ItineraryPoint

  • Budgets that limit the range. All budgets must be of the same type.

    Declaration

    Swift

    public let budgets: Set<Budget>

  • Options governing which paths to prefer.

    Declaration

    Swift

    public let costModel: CostModel?

  • A departure time for the route.

    Declaration

    Swift

    public let departAt: Date?

  • A polyline that must be fully included in the range.

    Declaration

    Swift

    public let routeToInclude: [CLLocationCoordinate2D]?

  • The vehicle dimensions, restrictions and engine parameters.

    Declaration

    Swift

    public let vehicle: Vehicle?

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

    Declaration

    Swift

    public let queryOptions: QueryOptions?

RangeCalculationOptions

  • Copies the current RangeCalculationOptions with changes specified in build closure

    Declaration

    Swift

    public func copy(build: (inout Builder) throws -> ()) throws -> RangeCalculationOptions

    Parameters

    build

    This closure allows for change of RangeCalculationOptions values

    Return Value

    RangeCalculationOptions with the changes set on the closure

  • The Builder creates a new instance of RangeCalculationOptions with modified fields.

    Declaration

    Swift

    public struct Builder