Package com.navmii.sdk.routecalculation

Class SnappingOptions

java.lang.Object
com.navmii.sdk.routecalculation.SnappingOptions
public abstract class SnappingOptions
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Constructor Description
    SnappingOptions()  

  • Method Summary

    Modifier and Type Method Description
    static SnappingOptions create()
    Creates SnappingOptions with default values.
    static SnappingOptions createInWalkingMode()
    Creates SnappingOptions with default values except the isWalkingMode property, which is initialized with 'true'.
    static SnappingOptions createWithTraffic​(TrafficSnapshot trafficSnapshot)
    Creates SnappingOptions with default values except the trafficSnapshot property, which is initialized with the specified traffic snapshot.
    abstract boolean getAvoidTollRoads()
    Specifies whether toll roads should be avoided.
    abstract boolean getConsiderTraffic()
    Specifies whether traffic should be considered during route calculation.
    abstract boolean getIsWalkingMode()
    Specifies whether walking mode is used.
    abstract int getMaxSnappingDistanceInMeters()
    Limits the distance of the route being snapped at once.
    abstract TrafficSnapshot getTrafficSnapshot()
    A traffic snapshot which is used in route calculation and visualisation of the route polyline.
    abstract boolean getUseProvidedTimesToCalculateEta()
    Specifies whether the ETA of a route should be calculated using time data from the external route.
    abstract VehicleType getVehicleType()
    Specifies vehicle type.
    abstract void setAvoidTollRoads​(boolean avoidTollRoads)
    Specifies whether toll roads should be avoided.
    abstract void setConsiderTraffic​(boolean considerTraffic)
    Specifies whether traffic should be considered during route calculation.
    abstract void setIsWalkingMode​(boolean isWalkingMode)
    Specifies whether walking mode is used.
    abstract void setMaxSnappingDistanceInMeters​(int maxSnappingDistanceForInMeters)
    Limits the distance of the route being snapped at once.
    abstract void setTrafficSnapshot​(TrafficSnapshot trafficSnapshot)
    A traffic snapshot which is used in route calculation and visualisation of the route polyline.
    abstract void setUseProvidedTimesToCalculateEta​(boolean useServerTimesToCalculateEta)
    Specifies whether the ETA of a route should be calculated using time data from the external route.
    abstract void setVehicleType​(VehicleType vehicleType)
    Specifies vehicle type.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getIsWalkingMode

      public abstract boolean getIsWalkingMode()
      Specifies whether walking mode is used. Default value is 'false'.

    • setIsWalkingMode

      public abstract void setIsWalkingMode​(boolean isWalkingMode)
      Specifies whether walking mode is used.

    • getVehicleType

      public abstract VehicleType getVehicleType()
      Specifies vehicle type. The property is ignored in walking mode. Default value is VehicleType_Car.

    • setVehicleType

      public abstract void setVehicleType​(VehicleType vehicleType)
      Specifies vehicle type. The property is ignored in walking mode.

    • getAvoidTollRoads

      public abstract boolean getAvoidTollRoads()
      Specifies whether toll roads should be avoided. The property is ignored in walking mode. Default value is 'false'.

    • setAvoidTollRoads

      public abstract void setAvoidTollRoads​(boolean avoidTollRoads)
      Specifies whether toll roads should be avoided. The property is ignored in walking mode.

    • getConsiderTraffic

      public abstract boolean getConsiderTraffic()
      Specifies whether traffic should be considered during route calculation. The property is ignored in walking mode. Default value is 'true'.

    • setConsiderTraffic

      public abstract void setConsiderTraffic​(boolean considerTraffic)
      Specifies whether traffic should be considered during route calculation. The property is ignored in walking mode.

    • getUseProvidedTimesToCalculateEta

      public abstract boolean getUseProvidedTimesToCalculateEta()
      Specifies whether the ETA of a route should be calculated using time data from the external route. If 'false' is specified, the ETA is calculated based on the time data obtained from maps locally on the device. This option is ignored in walking mode. Default value is 'true'.

    • setUseProvidedTimesToCalculateEta

      public abstract void setUseProvidedTimesToCalculateEta​(boolean useServerTimesToCalculateEta)
      Specifies whether the ETA of a route should be calculated using time data from the external route. If 'false' is specified, the ETA is calculated based on the time data obtained from maps locally on the device. This option is ignored in walking mode. Default value is 'true'.

    • getMaxSnappingDistanceInMeters

      public abstract int getMaxSnappingDistanceInMeters()
      Limits the distance of the route being snapped at once. If the specified distance is less than the route length, the remaining part of the route will be snapped while navigating. Setting this property to -1 indicates that snapping distance is unlimited and the whole route should be snapped immediately after obtaining the route. Please note that in case of the online version of the SDK setting large values or -1 may slow down the whole snapping process, because the SDK needs to downoad all the map tiles along the part of the route being snapped. Default value is 100,000 meters.

    • setMaxSnappingDistanceInMeters

      public abstract void setMaxSnappingDistanceInMeters​(int maxSnappingDistanceForInMeters)
      Limits the distance of the route being snapped at once. If the specified distance is less than the route length, the remaining part of the route will be snapped while navigating. Setting this property to -1 indicates that snapping distance is unlimited and the whole route should be snapped immediately after obtaining the route. Please note that in case of the online version of the SDK setting large values or -1 may slow down the whole snapping process, because the SDK needs to downoad all the map tiles along the part of the route being snapped. Default value is 100,000 meters.

    • getTrafficSnapshot

      public abstract TrafficSnapshot getTrafficSnapshot()
      A traffic snapshot which is used in route calculation and visualisation of the route polyline. The source of the traffic snapshot is another SDK module. If you want to consider traffic in route calculation and display it on the route polyline after the route is calculated you need to set valid nonnull value to this property. Default value is 'null'.

    • setTrafficSnapshot

      public abstract void setTrafficSnapshot​(TrafficSnapshot trafficSnapshot)
      A traffic snapshot which is used in route calculation and visualisation of the route polyline. The source of the traffic snapshot is another SDK module. If you want to consider traffic in route calculation and display it on the route polyline after the route is calculated you need to set valid nonnull value to this property.

    • create

      public static SnappingOptions create()
      Creates SnappingOptions with default values.

    • createInWalkingMode

      public static SnappingOptions createInWalkingMode()
      Creates SnappingOptions with default values except the isWalkingMode property, which is initialized with 'true'.

    • createWithTraffic

      public static SnappingOptions createWithTraffic​(TrafficSnapshot trafficSnapshot)
      Creates SnappingOptions with default values except the trafficSnapshot property, which is initialized with the specified traffic snapshot.
      Parameters:
      trafficSnapshot - Traffic snapshot to initialize SnappingOptions with.