TTLongDistanceEVRoutingQueryBuilder

Objective-C

@interface TTLongDistanceEVRoutingQueryBuilder : NSObject

Swift

class TTLongDistanceEVRoutingQueryBuilder : NSObject

A builder for LongDistanceEVRoutingQuery.

  • Unavailable

    Use the createWithOrigin method to create the builder.

    Declaration

    Objective-C

    - (instancetype _Nonnull)init;

  • Creates an instance of LongDistanceEVRoutingQueryBuilder.

    Declaration

    Objective-C

    + (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)
                     createWithOrigin:(CLLocationCoordinate2D)origin
                          destination:(CLLocationCoordinate2D)destination
    speedConsumptionInKWhPerHundredKm:
        (nonnull NSDictionary<NSNumber *, NSNumber *> *)
            speedConsumptionInKWhPerHundredKm
                   currentChargeInKWh:(double)currentChargeInKWh
                       maxChargeInkWh:(double)maxChargeInkWh
          minChargeAtDestinationInkWh:(double)minChargeAtDestinationInkWh
        minChargeAtChargingStopsInkWh:(double)minChargeAtChargingStopsInkWh
                        chargingModes:
                            (NSArray<TTChargingMode *> *_Nonnull)chargingModes;

    Swift

    class func create(withOrigin origin: CLLocationCoordinate2D, destination: CLLocationCoordinate2D, speedConsumptionInKWhPerHundredKm: [NSNumber : NSNumber], currentChargeInKWh: Double, maxChargeInkWh: Double, minChargeAtDestinationInkWh: Double, minChargeAtChargingStopsInkWh: Double, chargingModes: [TTChargingMode]) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    origin

    Origin location of a route.
    destination

    Destination location of a route.
    speedConsumptionInKWhPerHundredKm

    Specifies the speed-dependent component of consumption in kWh.
    currentChargeInKWh

    Specifies the current electric energy supply in kWh.
    maxChargeInkWh

    Specifies the maximum electric energy supply in kWh that may be stored in the vehicle’s battery.
    minChargeAtDestinationInkWh

    The battery level upon arrival at the destination of the resulting route will be at least this much. Maximum value: maxChargeInkWh
    minChargeAtChargingStopsInkWh

    The battery level upon arrival at each intermediate charging stop of the resulting route will be at least this much. Maximum value: 0.2 × maxChargeInkWh.
    chargingModes

    A non-empty list of at most 10 chargingModes, which the vehicle is able to use to charge. Each chargingConnection appears in at most one chargingMode.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withReport:
    (TTEvReportType)reportType;

    Swift

    func withReport(_ reportType: TTEvReportType) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    report

    Specifies which data should be reported for diagnosis purposes.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withDepartAt:
    (nonnull NSString *)departAt;

    Swift

    func withDepartAt(_ departAt: String) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    departAt

    The date and time of departure from the origin point.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withRouteType:
    (TTEvRouteType)routeType;

    Swift

    func withRouteType(_ routeType: TTEvRouteType) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    routeType

    The type of route requested.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withTraffic:
    (BOOL)considerTraffic;

    Swift

    func withTraffic(_ considerTraffic: Bool) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    isTraffic

    Specifies whether the traffic information will be considered.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withAvoidType:
    (TTEvAvoidType)avoidType;

    Swift

    func withAvoidType(_ avoidType: TTEvAvoidType) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    avoidType

    Specifies something that the route calculation should try to avoid when determining the route.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withTravelMode:
    (TTEvTravelMode)travelMode;

    Swift

    func withTravelMode(_ travelMode: TTEvTravelMode) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    travelMode

    The mode of travel for the requested route.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleMaxSpeedInKph:
    (int)vehicleMaxSpeedInKph;

    Swift

    func withVehicleMaxSpeed(inKph vehicleMaxSpeedInKph: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleMaxSpeedInKph

    Maximum speed of the vehicle in km/hour.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleWeightInKg:
    (int)vehicleWeightInKg;

    Swift

    func withVehicleWeight(inKg vehicleWeightInKg: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleWeightInKg

    Weight of the vehicle in kilograms.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleAxleWeightInKg:
    (int)vehicleAxleWeightInKg;

    Swift

    func withVehicleAxleWeight(inKg vehicleAxleWeightInKg: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleAxleWeightInKg

    Weight per axle of the vehicle in kg.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleLengthInMeters:
    (int)vehicleLengthInMeters;

    Swift

    func withVehicleLength(inMeters vehicleLengthInMeters: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleLengthInMeters

    Length of the vehicle in meters.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleWidthInMeters:
    (int)vehicleWidthInMeters;

    Swift

    func withVehicleWidth(inMeters vehicleWidthInMeters: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleWidthInMeters

    Width of the vehicle in meters.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleHeightInMeters:
    (int)vehicleHeightInMeters;

    Swift

    func withVehicleHeight(inMeters vehicleHeightInMeters: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleHeightInMeters

    Height of the vehicle in meters.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withIsVehicleCommercial:
    (BOOL)isVehicleCommercial;

    Swift

    func withIsVehicleCommercial(_ isVehicleCommercial: Bool) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    isVehicleCommercial

    Specifies whether the vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleLoadType:
    (TTEvVehicleLoadType)vehicleLoadType;

    Swift

    func withVehicleLoadType(_ vehicleLoadType: TTEvVehicleLoadType) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleLoadType

    Types of cargo that may be classified as hazardous materials and restricted from some roads. vehicleLoadType can be specified multiple times.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)
    withVehicleAdrTunnelRestrictionCode:
        (TTEvVehicleAdrTunnelRestrictionCode)vehicleAdrTunnelRestrictionCode;

    Swift

    func withVehicleAdrTunnelRestrictionCode(_ vehicleAdrTunnelRestrictionCode: TTEvVehicleAdrTunnelRestrictionCode) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleAdrTunnelRestrictionCode

    If vehicleAdrTunnelRestrictionCode is specified, the vehicle is subject to ADR tunnel restrictions.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withAccelerationEfficiency:
    (double)accelerationEfficiency;

    Swift

    func withAccelerationEfficiency(_ accelerationEfficiency: Double) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    accelerationEfficiency

    Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withDecelerationEfficiency:
    (double)decelerationEfficiency;

    Swift

    func withDecelerationEfficiency(_ decelerationEfficiency: Double) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    decelerationEfficiency

    Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withUphillEfficiency:
    (double)uphillEfficiency;

    Swift

    func withUphillEfficiency(_ uphillEfficiency: Double) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    uphillEfficiency

    Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withDownhillEfficiency:
    (double)downhillEfficiency;

    Swift

    func withDownhillEfficiency(_ downhillEfficiency: Double) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    downhillEfficiency

    Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withAuxiliaryPowerInKW:
    (double)auxiliaryPowerInKW;

    Swift

    func withAuxiliaryPower(inKW auxiliaryPowerInKW: Double) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    auxiliaryPowerInKW

    Specifies the amount of power consumed for sustaining auxiliary systems, in kWh.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withAvoidVignettes:
    (NSArray<NSString *> *_Nonnull)countryCodes;

    Swift

    func withAvoidVignettes(_ countryCodes: [String]) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    countryCodes

    Specifies countries in which all toll roads and vignettes will be avoided.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withAllowVignettes:
    (NSArray<NSString *> *_Nonnull)countryCodes;

    Swift

    func withAllowVignettes(_ countryCodes: [String]) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    countryCodes

    Specifies countries in which all toll roads and vignettes will be allowed.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withAvoidAreas:
    (NSArray<TTLatLonBounds *> *_Nonnull)areaCoordinates;

    Swift

    func withAvoidAreas(_ areaCoordinates: [TTLatLonBounds]) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    areaCoordinates

    Specifies areas which will be avoided.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withRouteRepresentation:
    (TTEvRouteRepresentation)routeRepresentation;

    Swift

    func withRouteRepresentation(_ routeRepresentation: TTEvRouteRepresentation) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    routeRepresentation

    The representation of the set of routes provided as a Response.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withVehicleHeading:
    (int)vehicleHeading;

    Swift

    func withVehicleHeading(_ vehicleHeading: Int32) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    vehicleHeading

    The directional heading of the vehicle in degrees starting at true North and continuing in a clockwise direction.

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQueryBuilder *_Nonnull)withSectionType:
    (TTEvSectionType)sectionType;

    Swift

    func withSectionType(_ sectionType: TTEvSectionType) -> TTLongDistanceEVRoutingQueryBuilder

    Parameters

    sectionType

    Specifies which of the section types is reported in the route Response. sectionType can be specified multiple times

    Return Value

    TTLongDistanceEVRoutingQueryBuilder

  • Declaration

    Objective-C

    - (TTLongDistanceEVRoutingQuery *_Nonnull)build;

    Swift

    func build() -> TTLongDistanceEVRoutingQuery

    Return Value

    TTLongDistanceEVRoutingQuery