RoutePreferencesObject

Objective-C


@interface RoutePreferencesObject : NSObject

Swift

class RoutePreferencesObject : NSObject

This class encapsulates route preferences object.

  • Initializes and returns a newly allocated object using the model data.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithModelData:(nonnull void *)data;

  • Returns the model data.

    Declaration

    Objective-C

    - (nonnull void *)getModelData;

  • Tests if avoid motorways is set. Default is false.

    Declaration

    Objective-C

    - (BOOL)getAvoidMotorways;

    Swift

    func getAvoidMotorways() -> Bool

  • Sets the avoid motorways flag.

    Declaration

    Objective-C

    - (void)setAvoidMotorways:(BOOL)state;

    Swift

    func setAvoidMotorways(_ state: Bool)

  • Tests if avoid toll roads is set. Default is false.

    Declaration

    Objective-C

    - (BOOL)getAvoidTollRoads;

    Swift

    func getAvoidTollRoads() -> Bool

  • Sets the avoid toll roads flag.

    Declaration

    Objective-C

    - (void)setAvoidTollRoads:(BOOL)state;

    Swift

    func setAvoidTollRoads(_ state: Bool)

  • Tests if avoid ferries is set. Default is false.

    Declaration

    Objective-C

    - (BOOL)getAvoidFerries;

    Swift

    func getAvoidFerries() -> Bool

  • Sets the avoid ferries flag.

    Declaration

    Objective-C

    - (void)setAvoidFerries:(BOOL)state;

    Swift

    func setAvoidFerries(_ state: Bool)

  • Tests if avoid turnaround instruction flag is set. Default is false.

    Declaration

    Objective-C

    - (BOOL)getAvoidTurnAroundInstruction;

    Swift

    func getAvoidTurnAroundInstruction() -> Bool

  • Set the avoid turnaround instruction flag. If set to true then the message “Turnaround when possible” will be avoided during navigation. @details This preference is always overridden in car / truck navigation route recalculations, in which cases the current driving direction is used. @details For car / truck this preference is used when setting a user roadblock during navigation. If set to false, a turn around instruction may be generated.

    Declaration

    Objective-C

    - (void)setAvoidTurnAroundInstruction:(BOOL)state;

    Swift

    func setAvoidTurnAroundInstruction(_ state: Bool)

  • Tests if avoid unpaved roads is set. Default is false.

    Declaration

    Objective-C

    - (BOOL)getAvoidUnpavedRoads;

    Swift

    func getAvoidUnpavedRoads() -> Bool

  • Sets the avoid unpaved roads flag.

    Declaration

    Objective-C

    - (void)setAvoidUnpavedRoads:(BOOL)state;

    Swift

    func setAvoidUnpavedRoads(_ state: Bool)

  • Tests if avoid carpool lanes is set. Default is false.

    Declaration

    Objective-C

    - (BOOL)getAvoidCarpoolLanes;

    Swift

    func getAvoidCarpoolLanes() -> Bool

  • Sets the avoid carpool lanes flag.

    Declaration

    Objective-C

    - (void)setAvoidCarpoolLanes:(BOOL)state;

    Swift

    func setAvoidCarpoolLanes(_ state: Bool)

  • Get route type. Default is Fastest.

    Declaration

    Objective-C

    - (RouteType)getRouteType;

    Swift

    func getRouteType() -> RouteType

  • Sets the route type.

    Declaration

    Objective-C

    - (void)setRouteType:(RouteType)type;

    Swift

    func setRouteType(_ type: RouteType)

  • Get transport mode. Default is Car.

    Declaration

    Objective-C

    - (RouteTransportMode)getTransportMode;

    Swift

    func getTransportMode() -> RouteTransportMode

  • Sets the transport mode.

    Declaration

    Objective-C

    - (void)setTransportMode:(RouteTransportMode)type;

    Swift

    func setTransportMode(_ type: RouteTransportMode)

  • Get algorithm type.

    Declaration

    Objective-C

    - (RouteAlgorithmType)getAlgorithmType;

    Swift

    func getAlgorithmType() -> RouteAlgorithmType

  • Set algorithm type.

    Declaration

    Objective-C

    - (void)setAlgorithmType:(RouteAlgorithmType)type;

    Swift

    func setAlgorithmType(_ type: RouteAlgorithmType)

  • Get sorting strategy.

    Declaration

    Objective-C

    - (PTRouteSortingStrategy)getSortingStrategy;

    Swift

    func getSortingStrategy() -> PTRouteSortingStrategy

  • Set sorting strategy.

    Declaration

    Objective-C

    - (void)setSortingStrategy:(PTRouteSortingStrategy)type;

    Swift

    func setSortingStrategy(_ type: PTRouteSortingStrategy)

  • Get timestamp.

    Declaration

    Objective-C

    - (nonnull TimeObject *)getTimestamp;

    Swift

    func getTimestamp() -> TimeObject

  • Set timestamp.

    Declaration

    Objective-C

    - (void)setTimestamp:(nonnull TimeObject *)time;

    Swift

    func setTimestamp(_ time: TimeObject)

  • Get use wheelchair.

    Declaration

    Objective-C

    - (BOOL)getUseWheelchair;

    Swift

    func getUseWheelchair() -> Bool

  • Set use wheelchair.

    Declaration

    Objective-C

    - (void)setUseWheelchair:(BOOL)state;

    Swift

    func setUseWheelchair(_ state: Bool)

  • Get use bikes.

    Declaration

    Objective-C

    - (BOOL)getUseBikes;

    Swift

    func getUseBikes() -> Bool

  • Sett use bikes.

    Declaration

    Objective-C

    - (void)setUseBikes:(BOOL)state;

    Swift

    func setUseBikes(_ state: Bool)

  • Get minimum transfer time in minutes. Default is 0.

    Declaration

    Objective-C

    - (int)getMinimumTransferTimeInMinutes;

    Swift

    func getMinimumTransferTimeInMinutes() -> Int32

  • Set minimum transfer time in minutes.

    Declaration

    Objective-C

    - (void)setMinimumTransferTimeInMinutes:(int)value;

    Swift

    func setMinimumTransferTimeInMinutes(_ value: Int32)

  • Get maximum transfer time in minutes. Default is 300.

    Declaration

    Objective-C

    - (unsigned int)getMaximumTransferTimeInMinutes;

    Swift

    func getMaximumTransferTimeInMinutes() -> UInt32

  • Set maximum transfer time in minutes.

    Declaration

    Objective-C

    - (void)setMaximumTransferTimeInMinutes:(unsigned int)value;

    Swift

    func setMaximumTransferTimeInMinutes(_ value: UInt32)

  • Get maximum walk distance. Default is 4000.

    Declaration

    Objective-C

    - (unsigned int)getMaximumWalkDistance;

    Swift

    func getMaximumWalkDistance() -> UInt32

  • Set maximum walk distance in meters.

    Declaration

    Objective-C

    - (void)setMaximumWalkDistance:(unsigned int)value;

    Swift

    func setMaximumWalkDistance(_ value: UInt32)

  • Get route calculation traffic avoidance method. @details Default is TrafficAvoidanceTypeNone.

    Declaration

    Objective-C

    - (TrafficAvoidanceType)getAvoidTraffic;

    Swift

    func getAvoidTraffic() -> TrafficAvoidanceType

  • Enable / disable traffic information usage for route calculation.

    Declaration

    Objective-C

    - (void)setAvoidTraffic:(BOOL)state;

    Swift

    func setAvoidTraffic(_ state: Bool)

  • Set route calculation traffic avoidance method. @details Default is TrafficAvoidance None.

    Declaration

    Objective-C

    - (void)setAvoidTrafficType:(TrafficAvoidanceType)type;

    Swift

    func setAvoidTrafficType(_ type: TrafficAvoidanceType)

  • Returns true if alternative routes balanced sorting is enabled.

    Declaration

    Objective-C

    - (BOOL)getAlternativeRoutesBalancedSorting;

    Swift

    func getAlternativeRoutesBalancedSorting() -> Bool

  • Enable / disable alternatives routes balanced sorting.

    Declaration

    Objective-C

    - (void)setAlternativeRoutesBalancedSorting:(BOOL)state;

    Swift

    func setAlternativeRoutesBalancedSorting(_ state: Bool)

  • Get route type preferences. Default is 0 - no special preference for one route type.

    Declaration

    Objective-C

    - (int)getRouteTypePreferences;

    Swift

    func getRouteTypePreferences() -> Int32

  • Set route type preferences. Example ( RoutePreferenceTypeBus | RoutePreferenceTypeUnderground )

    Declaration

    Objective-C

    - (void)setRouteTypePreferences:(int)value;

    Swift

    func setRouteTypePreferences(_ value: Int32)

  • Get group ids for earlier / later trip.

    Declaration

    Objective-C

    - (nonnull NSArray<NSNumber *> *)getRouteGroupIdsEarlierLater;

    Swift

    func getRouteGroupIdsEarlierLater() -> [NSNumber]

  • Set group ids for earlier / later trip.

    Declaration

    Objective-C

    - (void)setRouteGroupIdsEarlierLater:(nonnull NSArray<NSNumber *> *)array;

    Swift

    func setRouteGroupIdsEarlierLater(_ array: [NSNumber])

  • Get terrain profile build.

    Declaration

    Objective-C

    - (BOOL)getBuildTerrainProfile;

    Swift

    func getBuildTerrainProfile() -> Bool

  • Set terrain profile build.

    Declaration

    Objective-C

    - (void)setBuildTerrainProfile:(BOOL)state;

    Swift

    func setBuildTerrainProfile(_ state: Bool)

  • Get selected bike profile.

    Declaration

    Objective-C

    - (BikeProfile)getBikeProfile;

    Swift

    func getBikeProfile() -> BikeProfile

  • Set bike profile.

    Declaration

    Objective-C

    - (void)setBikeProfile:(BikeProfile)profile;

    Swift

    func setBikeProfile(_ profile: BikeProfile)

  • Set bike profile with EBike profile details.

    Declaration

    Objective-C

    - (void)setBikeProfile:(BikeProfile)profile
    withEBikeProfileDetails:(EBikeProfileDetails)eBikeProfileDetails;

    Swift

    func setBikeProfile(_ profile: BikeProfile, with eBikeProfileDetails: EBikeProfileDetails)

  • Get the EBike profile details.

    Declaration

    Objective-C

    - (EBikeProfileDetails)getEBikeProfileDetails;

    Swift

    func getEBikeProfileDetails() -> EBikeProfileDetails

  • Get the default bike profile details.

    Declaration

    Objective-C

    - (EBikeProfileDetails)getDefaultEBikeProfile;

    Swift

    func getDefaultEBikeProfile() -> EBikeProfileDetails

  • Deprecated

    Please use getFitnessFactor.

    Get avoid biking hill factor.

    Declaration

    Objective-C

    - (float)getAvoidBikingHillFactor;

    Swift

    func getAvoidBikingHillFactor() -> Float

  • Deprecated

    Please use setFitnessFactor.

    Set avoid biking hill factor. @details 0.f - no avoidance, 1.f - full avoidance.

    Declaration

    Objective-C

    - (void)setAvoidBikingHillFactor:(float)factor;

    Swift

    func setAvoidBikingHillFactor(_ factor: Float)

  • Get bike & pedestrian routing fitness factor. @details Default is 0.5 ( normal / good shape ).

    Declaration

    Objective-C

    - (float)getFitnessFactor;

    Swift

    func getFitnessFactor() -> Float

  • Set the bike & pedestrian routing fitness factor.

    Declaration

    Objective-C

    - (void)setFitnessFactor:(float)factor;

    Swift

    func setFitnessFactor(_ factor: Float)

    Parameters

    factor

    The fitness factor in range [0, 1], 0.f - untrained , 1.f - professional @details The fitness factor affects route path configuration. @details For mountain bike and pedestrian hiking profiles the fitness factor is used to boost to steeper slopes in path links selection. @details For city bike, road bike and cross bike the fitness factor is used to avoid steeper slopes in path links selection.

  • Get pedestrian profile.

    Declaration

    Objective-C

    - (PedestrianProfile)getPedestrianProfile;

    Swift

    func getPedestrianProfile() -> PedestrianProfile

  • Set pedestrian profile.

    Declaration

    Objective-C

    - (void)setPedestrianProfile:(PedestrianProfile)profile;

    Swift

    func setPedestrianProfile(_ profile: PedestrianProfile)

  • Gets truck profile.

    Declaration

    Objective-C

    - (TruckProfileDetails)getTruckProfile;

    Swift

    func getTruckProfile() -> TruckProfileDetails

  • Sets truck profile.

    Declaration

    Objective-C

    - (void)setTruckProfile:(TruckProfileDetails)profile;

    Swift

    func setTruckProfile(_ profile: TruckProfileDetails)

  • Set route ranges list. @details A non empty int range list will generate an isocost range route result. @details Range result quality must a valid integer in 0 - 100 range, 0 = lowest quality, 100 = highest quality. @details Ranges units depends on route type: Fastest - seconds, Shortest - meters, Economic - Wh.

    Declaration

    Objective-C

    - (void)setRouteRanges:(nonnull NSArray<NSNumber *> *)array
               quality:(int)quality;

    Swift

    func setRouteRanges(_ array: [NSNumber], quality: Int32)

  • Get route ranges list.

    Declaration

    Objective-C

    - (nonnull NSArray<NSNumber *> *)getRouteRanges;

    Swift

    func getRouteRanges() -> [NSNumber]

  • Get route range quality. @details Default is 100 ( max quality ).

    Declaration

    Objective-C

    - (int)getRouteRangesQuality;

    Swift

    func getRouteRangesQuality() -> Int32

  • Get result details.

    Declaration

    Objective-C

    - (RouteResultDetails)getResultDetails;

    Swift

    func getResultDetails() -> RouteResultDetails

  • Set result details.

    Declaration

    Objective-C

    - (void)setResultDetails:(RouteResultDetails)details;

    Swift

    func setResultDetails(_ details: RouteResultDetails)

  • Get alternative schema.

    Declaration

    Objective-C

    - (RouteAlternativesSchema)getAlternativesSchema;

    Swift

    func getAlternativesSchema() -> RouteAlternativesSchema

  • Set alternative schema.

    Declaration

    Objective-C

    - (void)setAlternativesSchema:(RouteAlternativesSchema)schema;

    Swift

    func setAlternativesSchema(_ schema: RouteAlternativesSchema)

  • Get service maximum distance constraint. Default is active. @details Maximum distance constraint depends on transport and result details.

    Declaration

    Objective-C

    - (BOOL)getMaximumDistanceConstraint;

    Swift

    func getMaximumDistanceConstraint() -> Bool

  • Set maximum distance constraint.

    Declaration

    Objective-C

    - (void)setMaximumDistanceConstraint:(BOOL)state;

    Swift

    func setMaximumDistanceConstraint(_ state: Bool)

  • Set the ignore map restrictions in route-over-track mode. @details Default is false

    Declaration

    Objective-C

    - (void)setIgnoreRestrictionsOverTrack:(BOOL)state;

    Swift

    func setIgnoreRestrictionsOverTrack(_ state: Bool)

  • Get the ignore map restrictions in route-over-track mode. @details Default is false.

    Declaration

    Objective-C

    - (BOOL)getIgnoreRestrictionsOverTrack;

    Swift

    func getIgnoreRestrictionsOverTrack() -> Bool

  • Set the track accurate match.

    Declaration

    Objective-C

    - (void)setAccurateTrackMatch:(BOOL)value;

    Swift

    func setAccurateTrackMatch(_ value: Bool)

  • Get the track accurate match. @details Default is true.

    Declaration

    Objective-C

    - (BOOL)getAccurateTrackMatch;

    Swift

    func getAccurateTrackMatch() -> Bool

  • Set the track resume mode. @details If true, the track will be used in routing from the closest coordinate until the last. @details At least one waypoint before the track waypoint should be configured - this will determine the closest position on track. @details If false, the track will be used entirely in routing, from the first coordinate until the last.

    Declaration

    Objective-C

    - (void)setTrackResume:(BOOL)value;

    Swift

    func setTrackResume(_ value: Bool)

  • Get the track resume mode. The default value is true.

    Declaration

    Objective-C

    - (BOOL)getTrackResume;

    Swift

    func getTrackResume() -> Bool

  • Set the emergency vehicle mode.

    Declaration

    Objective-C

    - (void)setEmergencyVehicleMode:(BOOL)mode;

    Swift

    func setEmergencyVehicleMode(_ mode: Bool)

    Parameters

    mode

    The emergency vehicle mode, true for activation. @details Emergency mode enables setAvoidTurnAroundInstruction setting also for car/truck. @details Emergency mode enables access to emergency dedicated links. @details Default is false.

  • Set the emergency vehicle mode.

    Declaration

    Objective-C

    - (void)setEmergencyVehicleMode:(BOOL)mode extraFreedom:(int)extraFreedom;

    Swift

    func setEmergencyVehicleMode(_ mode: Bool, extraFreedom: Int32)

    Parameters

    mode

    The emergency vehicle mode, true for activation.
    extraFreedom

    The extra freedom levels for emergency vehicles, packed in an integer value. See EmergencyExtraFreedomLevels for possible values. @details Emergency mode enables setAvoidTurnAroundInstruction setting also for car/truck. @details Emergency mode enables access to emergency dedicated links. @details Default is false

  • Get the emergency vehicle mode.

    Declaration

    Objective-C

    - (BOOL)getEmergencyVehicleMode;

    Swift

    func getEmergencyVehicleMode() -> Bool

  • Get the emergency vehicle extra freedom levels packed in an integer value. See EmergencyExtraFreedomLevels for possible values

    Declaration

    Objective-C

    - (int)getEmergencyVehicleExtraFreedomLevels;

    Swift

    func getEmergencyVehicleExtraFreedomLevels() -> Int32

  • Get path algorithm.

    Declaration

    Objective-C

    - (RoutePathAlgorithmType)getPathAlgorithm;

    Swift

    func getPathAlgorithm() -> RoutePathAlgorithmType

  • Set path algorithm.

    Declaration

    Objective-C

    - (void)setPathAlgorithm:(RoutePathAlgorithmType)algorithmType;

    Swift

    func setPathAlgorithm(_ algorithmType: RoutePathAlgorithmType)

  • Get path algorithm flavor. Default is RoutePathAlgorithmFlavorTypeMagicLane.

    Declaration

    Objective-C

    - (RoutePathAlgorithmFlavorType)getPathAlgorithmFlavor;

    Swift

    func getPathAlgorithmFlavor() -> RoutePathAlgorithmFlavorType

  • Set path algorithm flavor.

    Declaration

    Objective-C

    - (void)setPathAlgorithmFlavor:(RoutePathAlgorithmFlavorType)flavorType;

    Swift

    func setPathAlgorithmFlavor(_ flavorType: RoutePathAlgorithmFlavorType)

  • Get the departure heading in degrees.

    Declaration

    Objective-C

    - (double)getDepartureHeading;

    Swift

    func getDepartureHeading() -> Double

  • Get the departure heading accuracy in degrees.

    Declaration

    Objective-C

    - (double)getDepartureHeadingAccuracy;

    Swift

    func getDepartureHeadingAccuracy() -> Double

  • Set the departure heading in degrees.

    Declaration

    Objective-C

    - (void)setDepartureHeading:(double)head accuracy:(double)accuracy;

    Swift

    func setDepartureHeading(_ head: Double, accuracy: Double)

    Parameters

    head

    The departure heading, in degrees east from north axis. @details Values are in 0 - 360 interval with 0 representing the magnetic north. @details Value -1 means no departure heading is specified.
    accuracy

    The departure heading accuracy, in degrees. @details Values are in 0 - 90 interval. A typical value is 25 degrees.

  • Get the online route calculation allowance. @details Default value is true.

    Declaration

    Objective-C

    - (BOOL)getAllowOnlineCalculation;

    Swift

    func getAllowOnlineCalculation() -> Bool

  • Set the online route calculation allowance.

    Declaration

    Objective-C

    - (void)setAllowOnlineCalculation:(BOOL)state;

    Swift

    func setAllowOnlineCalculation(_ state: Bool)

  • Set build route connections.

    Declaration

    Objective-C

    - (void)setBuildConnections:(BOOL)state maxLengthM:(int)maxLengthM;

    Swift

    func setBuildConnections(_ state: Bool, maxLengthM: Int32)

    Parameters

    state

    Enable connections build.
    maxLengthM

    Maximum connection length. For default set -1.

  • Get route connections build state.

    Declaration

    Objective-C

    - (BOOL)getBuildConnections;

    Swift

    func getBuildConnections() -> Bool

  • Get route connections build max length.

    Declaration

    Objective-C

    - (int)getBuildConnectionsMaxLength;

    Swift

    func getBuildConnectionsMaxLength() -> Int32

  • Get accurate waypoints approach. Default is false. @details An accurate approach implies that the route arrives at the waypoint on the drive side of the region.

    Declaration

    Objective-C

    - (BOOL)getAccurateWaypointsApproach;

    Swift

    func getAccurateWaypointsApproach() -> Bool

  • Set the accurate waypoints approach.

    Declaration

    Objective-C

    - (void)setAccurateWaypointsApproach:(BOOL)state;

    Swift

    func setAccurateWaypointsApproach(_ state: Bool)

    Parameters

    state

    The approach value, true for accurate approach.