Summary

public struct Summary

The route summary contains the high-level route data.

  • Creates an instance of Summary.

    Declaration

    Swift

    public init(
        length: Measurement<UnitLength>,
        travelTime: Measurement<UnitDuration>,
        trafficLength: Measurement<UnitLength>,
        trafficDelay: Measurement<UnitDuration>,
        departureTime: Date?,
        arrivalTime: Date?,
        consumptionForWholeLength: Consumption?,
        consumptionUpToReachableOffset: Consumption?,
        remainingBudget: Consumption?,
        reachableOffset: Measurement<UnitLength>?
    )

    Parameters

    length

    The route length.

    travelTime

    The estimated travel time.

    trafficLength

    The portion of the route or leg, that is affected by traffic events which cause the delay.

    trafficDelay

    The difference between the travel time calculated using all available traffic information.

    departureTime

    Departure time for the route or leg, specified in the departure location’s time zone.

    arrivalTime

    Estimated arrival time for the route or leg, specified in the destination’s location’s time zone.

    consumptionForWholeLength

    Consumption for the whole route or leg.

    consumptionUpToReachableOffset

    Consumption for the route or leg up to the reachable offset.

    remainingBudget

    Remaining fuel or energy when reaching the end of the route or leg.

    reachableOffset

    Portion of the route or leg that can be driven with the current energy or fuel supply.

  • Route or leg length.

    Declaration

    Swift

    public var length: Measurement<UnitLength>
  • Estimated travel time.

    Declaration

    Swift

    public var travelTime: Measurement<UnitDuration>
  • Portion of the route or leg, that is affected by traffic events which cause the delay.

    Declaration

    Swift

    public var trafficLength: Measurement<UnitLength>
  • Difference between the travel time calculated using all available traffic information and travel time calculated without the influence of current or historic traffic data.

    Declaration

    Swift

    public var trafficDelay: Measurement<UnitDuration>
  • Departure time for the route or leg, specified in the departure location’s time zone.

    Declaration

    Swift

    public var departureTime: Date?
  • Estimated arrival time for the route or leg, specified in the destination’s location’s time zone.

    Declaration

    Swift

    public var arrivalTime: Date?
  • Consumption for the whole route or leg.

    Declaration

    Swift

    public var consumptionForWholeLength: Consumption?
  • Consumption for the route or leg up to the reachable offset.

    Declaration

    Swift

    public var consumptionUpToReachableOffset: Consumption?
  • Remaining energy at the reachable offset.

    Declaration

    Swift

    public var remainingBudget: Consumption?
  • Portion of the route or leg that can be driven with the current energy or fuel supply.

    Declaration

    Swift

    public var reachableOffset: Measurement<UnitLength>?