TomTom SDK for iOS Efficiency

Efficiency

public struct Efficiency

Specifies the efficiency of the vehicle.

Note

This option is supported with the Orbis map only when chargingOptions are set in RoutePlanningOptions.

  • Creates an instance of Efficiency.

    Throws

    VehicleError.invalidVehicleSnapshot if the altitude change energy cannot be used together with altitude change efficiency and the velocity change efficiency.

    Declaration

    Swift

    public init(
    velocityChange: VelocityChangeEfficiency? = nil,
    altitudeChange: AltitudeChangeEfficiency? = nil,
    altitudeChangeEnergy: AltitudeChangeEnergy? = nil
) throws

    Parameters

    velocityChange

    Specifies the efficiency of converting electric energy to kinetic energy due to accelerations, or vice versa for decelerations.
    altitudeChange

    Specifies the efficiency of converting electric energy to potential energy due to increase in altitude, or vice versa for decreases.
    altitudeChangeEnergy

    Specifies the additional consumption and recuperation of electric energy due to altitude changes. Cannot be used together with the other two options.

  • Specifies the efficiency of converting electric energy to kinetic energy due to accelerations, or vice versa for decelerations.

    Declaration

    Swift

    public let velocityChange: VelocityChangeEfficiency?

  • Specifies the efficiency of converting electric energy to potential energy due to increase in altitude, or vice versa for decreases.

    Declaration

    Swift

    public let altitudeChange: AltitudeChangeEfficiency?

  • Specifies the additional consumption and recuperation of electric energy due to altitude changes. Cannot be used together with the other two options.

    Declaration

    Swift

    public let altitudeChangeEnergy: AltitudeChangeEnergy?