Summary

public struct Summary

Summary of the whole route or the particular leg.

Lifecycle

  • Initializes a Summary to represent a summary.

    Declaration

    Swift

    public init(
    length: Measurement<UnitLength>,
    travelTime: Measurement<UnitDuration>,
    trafficDelay: Measurement<UnitDuration>,
    departureTimeDescription: String,
    arrivalTimeDescription: String,
    batteryConsumption: Measurement<UnitEnergy>?,
    fuelConsumption: Measurement<UnitVolume>?,
    remainingChargeAtArrival: Measurement<UnitEnergy>?,
    chargingInformationAtEndOfLeg: ChargingInformation?
)

    Parameters

    length

    The route length.
    travelTime

    The estimated travel time.
    trafficDelay

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

    The estimated departure time for the route or leg. Specified as a dateTime.
    arrivalTimeDescription

    The estimated arrival time for the route or leg. Specified as a dateTime.
    batteryConsumption

    The estimated electric energy consumption.
    fuelConsumption

    The estimated fuel consumption.
    remainingChargeAtArrival

    The estimated battery charge upon arrival at the end of the leg or the route.
    chargingInformationAtEndOfLeg

    The information about a charging stop on a route leg.

Public

  • Route or leg length.

    Declaration

    Swift

    public let length: Measurement<UnitLength>

  • Estimated travel time.

    Declaration

    Swift

    public let travelTime: Measurement<UnitDuration>

  • 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 let trafficDelay: Measurement<UnitDuration>

  • Estimated departure time for the route or leg. Specified as a dateTime.

    Declaration

    Swift

    public let departureTimeDescription: String

  • Estimated arrival time for the route or leg. Specified as a dateTime.

    Declaration

    Swift

    public let arrivalTimeDescription: String

  • Estimated electric energy consumption.

    Declaration

    Swift

    public let batteryConsumption: Measurement<UnitEnergy>?

  • Estimated fuel consumption.

    Declaration

    Swift

    public let fuelConsumption: Measurement<UnitVolume>?

  • Estimated battery charge upon arrival at the end of the leg or the route.

    Declaration

    Swift

    public let remainingChargeAtArrival: Measurement<UnitEnergy>?

  • Information about a charging stop on a route leg.

    Declaration

    Swift

    public let chargingInformationAtEndOfLeg: ChargingInformation?

Summary

  • Copies the current Summary with changes specified in build closure

    Declaration

    Swift

    public func copy(build: (inout Builder) -> ()) -> Summary

    Parameters

    build

    This closure allows for change of Summary values

    Return Value

    A Summary with the changes set on the closure