NSDK_RouteOptions

@interface NSDK_RouteOptions : NSObject

Options for routing.

@author PTV AG Karlsruhe

  • The factor is to understand as percentage of additional charge of cost of segments with toll. Default is 150.

    Declaration

    Objective-C

    - (int)getTollFactor;

    Swift

    func getTollFactor() -> Int32

    Return Value

    The toll factor.

  • The factor is to understand as percentage additional charge of cost of a segments with toll. Default is 150.

    Declaration

    Objective-C

    - (void)setTollFactor:(int)tollFactor;

    Swift

    func setTollFactor(_ tollFactor: Int32)

    Parameters

    tollFactor

    The toll factor to use.

  • If set to ‘YES’ then toll layers will be evaluated for route calculation. Default is ‘NO’.

    Declaration

    Objective-C

    - (BOOL)getUseTollLayer;

    Swift

    func getUseTollLayer() -> Bool

    Return Value

    whether toll layers are evaluated during route calculation.

  • If set to ‘YES’ then toll layers will be evaluated for route calculation. Default is ‘NO’.

    Declaration

    Objective-C

    - (void)setUseTollLayer:(BOOL)useTollLayer;

    Swift

    func setUseTollLayer(_ useTollLayer: Bool)

    Parameters

    useTollLayer

    Whether toll layers are to be evaluated during route calculation.

  • The factor is to understand as percentage additional charge of cost of a segments with truck toll. Default is 150.

    Declaration

    Objective-C

    - (void)setTruckTollFactor:(int)tollFactor;

    Swift

    func setTruckTollFactor(_ tollFactor: Int32)

    Parameters

    tollFactor

    The toll factor to use.

  • The factor is to understand as percentage of additional charge of cost of segments with truck toll. Default is 150.

    Declaration

    Objective-C

    - (int)getTruckTollFactor;

    Swift

    func getTruckTollFactor() -> Int32

    Return Value

    The truck toll factor.

  • If set to ‘YES’ then truck toll layers will be evaluated for route calculation. Default is ‘NO’.

    Declaration

    Objective-C

    - (BOOL)getUseTruckTollLayer;

    Swift

    func getUseTruckTollLayer() -> Bool

    Return Value

    whether truck toll layers are evaluated during route calculation.

  • If set to ‘YES’ then toll layers will be evaluated for route calculation. Default is ‘NO’.

    Declaration

    Objective-C

    - (void)setUseTruckTollLayer:(BOOL)useTollLayer;

    Swift

    func setUseTruckTollLayer(_ useTollLayer: Bool)

    Parameters

    useTollLayer

    Whether toll layers are to be evaluated during route calculation.

  • Class of dangerous goods. Maybe ‘A’, ‘B’, ‘C’, ‘D’, ‘E’.

    Declaration

    Objective-C

    - (short)getClassOfDangerousGoods;

    Swift

    func getClassOfDangerousGoods() -> Int16

    Return Value

    the class of dangerous goods.

  • Class of dangerous goods. Maybe ‘A’, ‘B’, ‘C’, ‘D’, ‘E’.

    Declaration

    Objective-C

    - (void)setClassOfDangerousGoods:(short)classOfDangerousGoods;

    Swift

    func setClassOfDangerousGoods(_ classOfDangerousGoods: Int16)

    Parameters

    classOfDangerousGoods

    The class of dangerous goods.

  • If set to true then .rrt layers will be evaluated for route calculation. Default is true.

    Declaration

    Objective-C

    - (BOOL)getUseRRTLayers;

    Swift

    func getUseRRTLayers() -> Bool

    Return Value

    whether use rrt-layers are evaluated during route calculation.

  • If set to true then .rrt layers will be evaluated for route calculation. Default is true.

    Declaration

    Objective-C

    - (void)setUseRRTLayers:(BOOL)useRRTLayers;

    Swift

    func setUseRRTLayers(_ useRRTLayers: Bool)

    Parameters

    useRRTLayers

    Whether .rrt layers are to be evaluated during route calculation.

  • If set to true a cross map routing will be formed even if start and destination are within the same map. Otherwise it will only use the local map which reduces the memory impact and reduces time for route calculation.

    Declaration

    Objective-C

    - (BOOL)getForceMRRouting;

    Swift

    func getForceMRRouting() -> Bool

    Return Value

    the cross map routing setting.

  • If set to true a cross map routing will be formed even if start and destination are within the same map. Otherwise it will only use the local map which reduces the memory impact and reduces time for route calculation.

    Declaration

    Objective-C

    - (void)setForceMRRouting:(BOOL)forceMRRouting;

    Swift

    func setForceMRRouting(_ forceMRRouting: Bool)

    Parameters

    forceMRRouting

    The cross map routing setting.

  • If set to true a cross map routing will use detail level maps in transit countries if available. Otherwise it will only use the MR map which reduces the memory impact and reduces time for route calculation.

    Declaration

    Objective-C

    - (BOOL)getNiceTransit;

    Swift

    func getNiceTransit() -> Bool

    Return Value

    the nice transit flag.

  • If set to true a cross map routing will use detail level maps in transit countries if available. Otherwise it will only use the MR map which reduces the memory impact and reduces time for route calculation.

    Declaration

    Objective-C

    - (void)setNiceTransit:(BOOL)niceTransit;

    Swift

    func setNiceTransit(_ niceTransit: Bool)

    Parameters

    niceTransit

    The nice transit flag to use.

  • returns true if lorry restrictions are considered during route calculation, false otherwise.

    Declaration

    Objective-C

    - (BOOL)getLorry;

    Swift

    func getLorry() -> Bool

    Return Value

    lorry restrictions set.

  • if set to ‘YES’ lorry restrictions should be taken into consideration during route calculation.

    Declaration

    Objective-C

    - (void)setLorry:(BOOL)lorry;

    Swift

    func setLorry(_ lorry: Bool)

    Parameters

    lorry

    Whether lorry restrictions are to be evaluated during route calculation.

  • If true, it’s possible to ignore LorryRestrictions at start and target.

    Declaration

    Objective-C

    - (BOOL)getViolateLorryRescrictions;

    Swift

    func getViolateLorryRescrictions() -> Bool

    Return Value

    the ignore LorryRestrictions setting.

  • If true, it’s possible to ignore LorryRestrictions at start and target.

    Declaration

    Objective-C

    - (void)setViolateLorryRescrictions:(BOOL)violateLorryRescrictions;

    Swift

    func setViolateLorryRescrictions(_ violateLorryRescrictions: Bool)

    Parameters

    violateLorryRescrictions

    The ignore LorryRestrictions setting.

  • If true, it’s possible to route through gates of premises at start and target.

    Declaration

    Objective-C

    - (BOOL)getPremisesRouting;

    Swift

    func getPremisesRouting() -> Bool

    Return Value

    the gates of premises setting.

  • If true, it’s possible to route through gates of premises at start and target.

    Declaration

    Objective-C

    - (void)setPremisesRouting:(BOOL)premisesRouting;

    Swift

    func setPremisesRouting(_ premisesRouting: Bool)

    Parameters

    premisesRouting

    - the gates of premises setting.

  • If true the route leads to the nearest segment outside the pedestrian zone and a trace through the pedestrian zone is added to the route. In the pedestrian zone itself no guidance will be available. Does not work with avoidPedestrianZoneOnDestination == true.

    Declaration

    Objective-C

    - (BOOL)getPedestrianRoutingToDestination;

    Swift

    func getPedestrianRoutingToDestination() -> Bool

    Return Value

    the current setting

  • If true the route leads to the nearest segment outside the pedestrian zone and a trace through the pedestrian zone is added to the route. In the pedestrian zone itself no guidance will be available. Does not work with avoidPedestrianZoneOnDestination == true!

    Declaration

    Objective-C

    - (void)setPedestrianRoutingToDestination:(BOOL)pedestrianRoutingToDestination;

    Swift

    func setPedestrianRoutingToDestination(_ pedestrianRoutingToDestination: Bool)

    Parameters

    pedestrianRoutingToDestination

    the new value to be set

  • If true the route leads to the nearest segment outside the pedestrian zone and a trace through the pedestrian zone is added to the route. In the pedestrian zone itself will be no guidance! Does not work with bAvoidPedestrianZoneOnDestination == true!

    Declaration

    Objective-C

    - (BOOL)getPedestrianRoutingFromStart;

    Swift

    func getPedestrianRoutingFromStart() -> Bool

    Return Value

    the current setting

  • If true the route leads to the nearest segment outside the pedestrian zone an a trace through the pedestrian zone is added to the route. In the pedastrian zone itself will be no guidance! Does not work with bAvoidPedestrianZoneOnDestination == true!

    Declaration

    Objective-C

    - (void)setPedestrianRoutingFromStart:(BOOL)pedestrianRoutingFromStart;

    Swift

    func setPedestrianRoutingFromStart(_ pedestrianRoutingFromStart: Bool)

    Parameters

    pedestrianRoutingFromStart

    the new value

  • If true don’t link to segments in pedestrian zones on destination.

    Declaration

    Objective-C

    - (BOOL)getAvoidPedestrianZoneOnDestination;

    Swift

    func getAvoidPedestrianZoneOnDestination() -> Bool

    Return Value

    the setting for avoiding pedestrian zones on destination

  • If true don’t link to segments in pedestrian zones on destination.

    Declaration

    Objective-C

    - (void)setAvoidPedestrianZoneOnDestination:
    (BOOL)avoidPedestrianZoneOnDestination;

    Swift

    func setAvoidPedestrianZoneOnDestination(_ avoidPedestrianZoneOnDestination: Bool)

    Parameters

    avoidPedestrianZoneOnDestination

    the setting for avoiding pedestrian zones on destination

  • If true don’t link to segments in pedestrian zones on start.

    Declaration

    Objective-C

    - (BOOL)getAvoidPedestrianZoneOnStart;

    Swift

    func getAvoidPedestrianZoneOnStart() -> Bool

    Return Value

    the setting for avoiding pedestrian zones on start

  • If true don’t link to segments in pedestrian zones on start.

    Declaration

    Objective-C

    - (void)setAvoidPedestrianZoneOnStart:(BOOL)avoidPedestrianZoneOnStart;

    Swift

    func setAvoidPedestrianZoneOnStart(_ avoidPedestrianZoneOnStart: Bool)

    Parameters

    avoidPedestrianZoneOnStart

    the setting for avoiding pedestrian zones on start

  • If true don’t link to tunnel on destination. May be useful if the destination is in an offroad position.

    Declaration

    Objective-C

    - (BOOL)getAvoidTunnelOnDestination;

    Swift

    func getAvoidTunnelOnDestination() -> Bool

    Return Value

    the setting for avoiding tunnel on destination.

  • If true don’t link to tunnel on destination. May be useful if the destination is in an offroad position.

    Declaration

    Objective-C

    - (void)setAvoidTunnelOnDestination:(BOOL)avoidTunnelOnDestination;

    Swift

    func setAvoidTunnelOnDestination(_ avoidTunnelOnDestination: Bool)

    Parameters

    avoidTunnelOnDestination

    the setting for avoiding tunnel on destination.

  • If true don’t link to tunnel on start. May be useful if the start is in an offroad position.

    Declaration

    Objective-C

    - (BOOL)getAvoidTunnelOnStart;

    Swift

    func getAvoidTunnelOnStart() -> Bool

    Return Value

    the setting for avoiding tunnel on start.

  • If true don’t link to tunnel on start. May be useful if the start is in an offroad position.

    Declaration

    Objective-C

    - (void)setAvoidTunnelOnStart:(BOOL)avoidTunnelOnStart;

    Swift

    func setAvoidTunnelOnStart(_ avoidTunnelOnStart: Bool)

    Parameters

    avoidTunnelOnStart

    the setting for avoiding tunnel on start.

  • If true don’t link to motorways on destination. May be useful if the destination is in an offroad position.

    Declaration

    Objective-C

    - (BOOL)getAvoidMotorwayOnDestination;

    Swift

    func getAvoidMotorwayOnDestination() -> Bool

    Return Value

    the setting for avoiding motorways on destination

  • If true don’t link to motorways on destination. May be useful if the destination is in an offroad position.

    Declaration

    Objective-C

    - (void)setAvoidMotorwayOnDestination:(BOOL)avoidMotorwayOnDestination;

    Swift

    func setAvoidMotorwayOnDestination(_ avoidMotorwayOnDestination: Bool)

    Parameters

    avoidMotorwayOnDestination

    the setting for avoiding motorways on destination

  • If true don’t link to motorways on start. May be useful if the start is in an offroad position.

    Declaration

    Objective-C

    - (BOOL)getAvoidMotorwayOnStart;

    Swift

    func getAvoidMotorwayOnStart() -> Bool

    Return Value

    the setting for avoiding motorways on start

  • If true don’t link to motorways on start. May be useful if the start is in an offroad position.

    Declaration

    Objective-C

    - (void)setAvoidMotorwayOnStart:(BOOL)avoidMotorwayOnStart;

    Swift

    func setAvoidMotorwayOnStart(_ avoidMotorwayOnStart: Bool)

    Parameters

    avoidMotorwayOnStart

    the setting for avoiding motorways on start

  • If true don’t link to ferries on destination. May be useful if the destination is in an offroad position.

    Declaration

    Objective-C

    - (BOOL)getAvoidFerryOnDestination;

    Swift

    func getAvoidFerryOnDestination() -> Bool

    Return Value

    the setting for avoiding ferries on destination.

  • If true don’t link to ferries on destination. May be useful if the destination is in an offroad position.

    Declaration

    Objective-C

    - (void)setAvoidFerryOnDestination:(BOOL)avoidFerryOnDestination;

    Swift

    func setAvoidFerryOnDestination(_ avoidFerryOnDestination: Bool)

    Parameters

    avoidFerryOnDestination

    the setting for avoiding ferries on destination.

  • If true don’t link to ferries on start. May be useful if the start is in an offroad position.

    Declaration

    Objective-C

    - (BOOL)getAvoidFerryOnStart;

    Swift

    func getAvoidFerryOnStart() -> Bool

    Return Value

    the setting for avoiding ferries on start.

  • If true don’t link to ferries on start. May be useful if the start is in an offroad position.

    Declaration

    Objective-C

    - (void)setAvoidFerryOnStart:(BOOL)avoidFerryOnStart;

    Swift

    func setAvoidFerryOnStart(_ avoidFerryOnStart: Bool)

    Parameters

    avoidFerryOnStart

    the setting for avoiding ferries on start.

  • Distance for road matching at the destination [Mercator units]. Mercator units for central europe are 1-2m;

    Declaration

    Objective-C

    - (int)getMatchDistDestination;

    Swift

    func getMatchDistDestination() -> Int32

    Return Value

    the distance for road matching at the destination

  • Distance for road matching at the destination [Mercator units]. Mercator units for central europe are 1-2m;

    Declaration

    Objective-C

    - (void)setMatchDistDestination:(int)matchDistDestination;

    Swift

    func setMatchDistDestination(_ matchDistDestination: Int32)

    Parameters

    matchDistDestination

    the distance for road matching at the destination.

  • Distance for road matching at the start [Mercator units]. Mercator units for central europe are 1-2m

    Declaration

    Objective-C

    - (int)getMatchDistStart;

    Swift

    func getMatchDistStart() -> Int32

    Return Value

    the distance for road matching at the start

  • Distance for road matching at the start [Mercator units]. Mercator units for central europe are 1-2m

    Declaration

    Objective-C

    - (void)setMatchDistStart:(int)matchDistStart;

    Swift

    func setMatchDistStart(_ matchDistStart: Int32)

    Parameters

    matchDistStart

    the distance for road matching at the start

  • Returns the vehicle type.

    Declaration

    Objective-C

    - (NSDK_RoutingVehicleType)getRoutingVehicle;

    Swift

    func getRoutingVehicle() -> NSDK_RoutingVehicleType

    Return Value

    the vehicle type

  • Sets the vehicle type.

    Declaration

    Objective-C

    - (void)setRoutingVehicle:(NSDK_RoutingVehicleType)routingVehicle;

    Swift

    func setRoutingVehicle(_ routingVehicle: NSDK_RoutingVehicleType)

    Parameters

    routingVehicle

    the vehicle type.

  • This parameter allows to control the handling of U-turns during the route- calculation. The value specifies, how much longer an alternative way without U-turn can be, before the shorter way with a U-turn is used. Allowed values range from 0 to 50000 seconds as impact for the route with U-turn.

    Declaration

    Objective-C

    - (int)getUTurnMalus;

    Swift

    func getUTurnMalus() -> Int32

    Return Value

    the U-turn malus value

  • This parameter allows to control the handling of U-turns during the route- calculation. The value specifies, how much longer an alternative way without U-turn can be, before the shorter way with a U-turn is used. Allowed values range from 0 to 50000 seconds as impact for the route with U-turn.

    Declaration

    Objective-C

    - (void)setUTurnMalus:(int)uTurnMalus;

    Swift

    func setUTurnMalus(_ uTurnMalus: Int32)

    Parameters

    uTurnMalus

    the U-turn malus value

  • This method can be used to set the desired speed profile for the route list (calculation of times). RoutingVehicle=NSDK_RVT_USER has to be specified to make this table become active! These are always scaled in steps of three speeds (fast, medium and slow) for motorways, national, country, urban, access roads and ferries. The values are in km/h. (independent of the option UseMetricSystem!) Users should avoid using modified speedtables if possible!

    Declaration

    Objective-C

    - (NSArray *)getSpeedTable_RouteList;

    Swift

    func getSpeedTable_RouteList() -> [Any]!

    Return Value

    the speedtable routelist.

  • This method can be used to set the desired speed profile for the route list (calculation of times). RoutingVehicle=NSDK_RVT_USER has to be specified to make this table become active! These are always scaled in steps of three speeds (fast, medium and slow) for motorways, national, country, urban, access roads and ferries. The values are in km/h. (independent of the option UseMetricSystem!) Users should avoid using modified speedtables if possible!

    Declaration

    Objective-C

    - (void)setSpeedTable_RouteList:(NSArray *)speedTable_RouteList;

    Swift

    func setSpeedTable_RouteList(_ speedTable_RouteList: [Any]!)

    Parameters

    speedTable_RouteList

    the speedtable routelist.

  • This method can be used to set the desired speed profile for route calculation. RoutingVehicle=NSDK_RVT_USER has to be specified to make this table become active! These are always scaled in steps of three speeds (fast, medium and slow) for motorways, national, country, urban, access roads and ferries. The values are in km/h independently of the option UseMetricSystem. Users should avoid using modified speedtables if possible!

    Declaration

    Objective-C

    - (NSArray *)getSpeedTable_Calc;

    Swift

    func getSpeedTable_Calc() -> [Any]!

    Return Value

    the speed profile.

  • This method can be used to set the desired speed profile for route calculation. RoutingVehicle=NSDK_RVT_USER has to be specified to make this table become active! These are always scaled in steps of three speeds (fast, medium and slow) for motorways, national, country, urban, access roads and ferries. The values are in km/h independently of the option UseMetricSystem. Users should avoid using modified speedtables if possible!

    Declaration

    Objective-C

    - (void)setSpeedTable_Calc:(NSArray *)speedTable_Calc;

    Swift

    func setSpeedTable_Calc(_ speedTable_Calc: [Any]!)

    Parameters

    speedTable_Calc

    the speed profile.

  • Returns the flag for controlling whether the route should avoid ferries.

    Declaration

    Objective-C

    - (BOOL)getRouteWithoutFerry;

    Swift

    func getRouteWithoutFerry() -> Bool

    Return Value

    the flag for controlling whether the route should avoid ferries.

  • Sets the flag for controlling whether the route should avoid ferries.

    Declaration

    Objective-C

    - (void)setRouteWithoutFerry:(BOOL)routeWithoutFerry;

    Swift

    func setRouteWithoutFerry(_ routeWithoutFerry: Bool)

    Parameters

    routeWithoutFerry

    the value for the flag.

  • Returns the flag for controlling whether the route should avoid motorways. This is only supported for routes up to 150km. For longer distances the route may again use motorways.

    Declaration

    Objective-C

    - (BOOL)getRouteWithoutAutoroute;

    Swift

    func getRouteWithoutAutoroute() -> Bool

    Return Value

    the flag for controlling whether the route should avoid motorways.

  • Sets the flag for controlling whether the route should avoid motorways. This is only supported for routes up to 150km. For longer distances the route may again use motorways.

    Declaration

    Objective-C

    - (void)setRouteWithoutAutoroute:(BOOL)routeWithoutAutoroute;

    Swift

    func setRouteWithoutAutoroute(_ routeWithoutAutoroute: Bool)

    Parameters

    routeWithoutAutoroute

    the flag for controlling whether the route should avoid motorways.

  • Not yet implemented.

    This parameter can be used to set the AltRoutesMalus. This malus makes it possible to influence how greatly the alternative route may deviate from the basic route. Streets that were already be used in the previous routes are considered more expensive in subsequent calculations.

    Declaration

    Objective-C

    - (int)getRouteMalus;

    Swift

    func getRouteMalus() -> Int32

    Return Value

    the current setting

  • Not yet implemented.

    This parameter can be used to set the AltRoutesMalus. This malus makes it possible to influence how greatly the alternative route may deviate from the basic route. Streets that were already be used in the previous routes are considered more expensive in subsequent calculations.

    Declaration

    Objective-C

    - (void)setAltRouteMalus:(int)altRouteMalus;

    Swift

    func setAltRouteMalus(_ altRouteMalus: Int32)

    Parameters

    altRouteMalus

    not implemented

  • Returns if an alternative route is set.

    This parameter can be used to set the alternative route that should be exported. At the moment 1 alternative route is supported. This default route has to be calculated first! 0 indicates default route, 1 the alternative route.

    Declaration

    Objective-C

    - (int)getAltRoute;

    Swift

    func getAltRoute() -> Int32

    Return Value

    info if an alternative route is set.

  • Sets the alternative or default route

    This parameter can be used to set the alternative route that should be exported. At the moment 1 alternative route is supported. This default route has to be calculated first! 0 indicates default route, 1 the alternative route.

    Declaration

    Objective-C

    - (void)setAltRoute:(int)altRoute;

    Swift

    func setAltRoute(_ altRoute: Int32)

    Parameters

    altRoute

    info if alternative or default route.

  • Returns the time factor.

    This parameter can be used to set the desired time factor. This factor can be used to influence the weight of distance and duration in the evaluation of routes. If set to 0 the time has no influence and the shortest route is searched. If the factor is set to 100 (%) time is considered as very important so the result is the fastest route prefering motorways and fast by-passes.

    Declaration

    Objective-C

    - (int)getTimeFactor;

    Swift

    func getTimeFactor() -> Int32

    Return Value

    the time factor.

  • Sets the time factor.

    This parameter can be used to set the desired time factor. This factor can be used to influence the weight of distance and duration in the evaluation of routes. If set to 0 the time has no influence and the shortest route is searched. If the factor is set to 100 (%) time is considered as very important so the result is the fastest route prefering motorways and fast by-passes.

    Declaration

    Objective-C

    - (void)setTimeFactor:(int)timeFactor;

    Swift

    func setTimeFactor(_ timeFactor: Int32)

    Parameters

    timeFactor

    the time factor.

  • get the type of route calculation (see NSDK_RouteCalculationType) NSDK_ROUTE_CLASSIC = classic routing, no alternative routes NSDK_ROUTE_ALTERNATIVE = routing with alternatives routes

    Declaration

    Objective-C

    - (NSDK_RouteCalculationType)getRouteCalculationType;

    Swift

    func getRouteCalculationType() -> NSDK_RouteCalculationType

    Return Value

    the type of routing, classic or with alternatives

  • Set the type of route calculation (see NSDK_RouteCalculationType) NSDK_ROUTE_CLASSIC = classic routing, no alternative routes NSDK_ROUTE_ALTERNATIVE = routing with alternatives routes

    Declaration

    Objective-C

    - (void)setRouteCalculationType:(NSDK_RouteCalculationType)routeCalculationType;

    Swift

    func setRouteCalculationType(_ routeCalculationType: NSDK_RouteCalculationType)

    Parameters

    routeCalculationType

    The type of routing, classic or with alternatives