Summary

public struct Summary

Summary of the whole route or the particular leg.

Important

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

Lifecycle


                    
                    
                    init(length:travelTime:trafficLength:trafficDelay:departureTimeDescription:arrivalTimeDescription:consumptionForWholeLength:consumptionUpToReachableOffset:remainingBudget:reachableOffset:)

Initializes a Summary to represent a summary.

Declaration

Swift

public init(
    length: Measurement<UnitLength>,
    travelTime: Measurement<UnitDuration>,
    trafficLength: Measurement<UnitLength>,
    trafficDelay: Measurement<UnitDuration>,
    departureTimeDescription: String,
    arrivalTimeDescription: String,
    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.
`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.
`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.

Public


                    
                    
                    length

Route or leg length.

Declaration

Swift

public let length: Measurement<UnitLength>


                    
                    
                    travelTime

Estimated travel time.

Declaration

Swift

public let travelTime: Measurement<UnitDuration>

trafficLength
Portion of the route or leg, that is affected by traffic events which cause the delay.
Declaration
Swift

public let trafficLength: Measurement<UnitLength>
trafficDelay
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>
departureTimeDescription
Estimated departure time for the route or leg. Specified as a dateTime.
Declaration
Swift

public let departureTimeDescription: String
arrivalTimeDescription
Estimated arrival time for the route or leg. Specified as a dateTime.
Declaration
Swift

public let arrivalTimeDescription: String
consumptionUpToReachableOffset
Consumption for the route or leg up to the reachable offset.
Declaration
Swift

public let consumptionUpToReachableOffset: Consumption?
remainingBudget
Remaining energy at the reachable offset.
Declaration
Swift

public let remainingBudget: Consumption?
reachableOffset
Portion of the route or leg that can be driven with the current energy or fuel supply.
Declaration
Swift

public let reachableOffset: Measurement<UnitLength>?

Summary


                    
                    
                    copy(build:)

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

Builder
The Builder creates the new instance of Summary with modified fields.
See more
Declaration
Swift

public struct Builder