sdk/com.sygic.sdk.route/RoutingOptions

RoutingOptions

open class RoutingOptions : BaseNativeParcelable

Class representing complex options available to route calculation.

Constructors

Link copied to clipboard
open fun RoutingOptions()
Default constructor.
Link copied to clipboard
open fun RoutingOptions(@NonNull original: RoutingOptions)
Copy constructor

Types

Link copied to clipboard
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class NearestAccessiblePointStrategy
Represents values describing different Nearest Accessible Point (NAP) settings.
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class RouteAvoid
Shows values describing routing options that can be used to enforce special conditions on a calculated route.
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class RoutingService
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class RoutingType
Represents values describing different routing types.
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class TransportMode
Represents values describing different transport modes, the mode of transportation a person will be using to travel a route (e.g.
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class TurnPreference
Link copied to clipboard
@Retention(value = RetentionPolicy.CLASS)
annotation class VehicleFuelType
Link copied to clipboard

Functions

Link copied to clipboard
open fun addDimensionalRestriction(restriction: Int, dimension: Int)
Link copied to clipboard
open fun addGeoPolylineAvoid(geoPolyline: GeoPolyline)
Set to avoid specific GeoPolyline.
Link copied to clipboard
open fun addGeoRectangleAvoid(geoBoundingBox: GeoBoundingBox)
Set to avoid specific GeoBoundingBox.
Link copied to clipboard
open fun addTrafficAvoid(traffic: TrafficInfo)
Set to avoid some traffic events.
Link copied to clipboard
open fun describeContents(): Int
Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
open fun generateExtendedInfo(): Boolean
Returns whether extended info should be generated
Link copied to clipboard
open fun getAvoidableCountries(): Set<String>
Returns avoidable countries.
Link copied to clipboard
@NonNull
open fun getAvoidedCountries(): List<String>
Returns countries which are avoided
Link copied to clipboard
@Nullable
open fun getDepartureTime(): Date
Returns the desired departure timer
Link copied to clipboard
open fun getDimensionalRestriction(restriction: Int): Int
Link copied to clipboard
open fun getEmissionStandard(): Int
Link copied to clipboard
open fun getGeoPolylineAvoids(): List<GeoPolyline>
Get geo polylines to be avoided.
Link copied to clipboard
open fun getGeoRectangleAvoids(): List<GeoBoundingBox>
Get geo rectangles to be avoided.
Link copied to clipboard
@NonNull
open fun getHazmatSettings(): HazmatSettings
Get current hazmat cargo options
Link copied to clipboard
open fun getMaxSpeed(): Int
Get the maximum speed, which a vehicle could achieve.
Link copied to clipboard
open fun getNAPStrategy(): Int
Returns what option is used for NAP.
Link copied to clipboard
open fun getRouteAvoids(): Map<String, Set<Integer>>
Returns all avoid for all countries.
Link copied to clipboard
open fun getRoutingService(): Int
Returns the type of routing service for computing the route.
Link copied to clipboard
open fun getRoutingType(): Int
Returns the route computing type.
Link copied to clipboard
open fun getTrafficAvoids(): Set<TrafficInfo>
Get traffic events to be avoided.
Link copied to clipboard
open fun getTransportMode(): Int
Returns the type of transport for computing the route.
Link copied to clipboard
open fun getTurnPreference(): Int
Link copied to clipboard
@Nullable
open fun getURLOverride(): String
Return override for default online routing URL.
Link copied to clipboard
open fun getVehicleFuelType(): Int
Link copied to clipboard
open fun getVehicleManufacturingYear(): Int
Get the year when the vehicle was manufactured
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun isBoatFerryAvoidable(countryIso: String): Boolean
Returns if the boat ferry can be avoided.
Link copied to clipboard
open fun isBoatFerryAvoided(): Boolean
open fun isBoatFerryAvoided(countryIso: String): Boolean
Returns if the boat ferry should be avoided when computing the route.
Link copied to clipboard
open fun isCountryAvoidable(@NonNull countryIso: String): Boolean
Returns if a country can be avoided.
Link copied to clipboard
open fun isCountryAvoided(@NonNull countryIso: String): Boolean
Returns if a country should be avoided when computing the route.
Link copied to clipboard
open fun isHighwayAvoidable(@NonNull countryIso: String): Boolean
Returns if the highway can be avoided.
Link copied to clipboard
open fun isHighwayAvoided(): Boolean
open fun isHighwayAvoided(@NonNull countryIso: String): Boolean
Returns if the highway should be avoided when computing the route.
Link copied to clipboard
open fun isSpecialAreaAvoidable(@NonNull countryIso: String): Boolean
Returns if the special area can be avoided.
Link copied to clipboard
open fun isSpecialAreaAvoided(): Boolean
open fun isSpecialAreaAvoided(@NonNull countryIso: String): Boolean
Returns if the special area should be avoided when computing the route.
Link copied to clipboard
open fun isTollRoadAvoidable(@NonNull countryIso: String): Boolean
Returns if the toll roads can be avoided.
Link copied to clipboard
open fun isTollRoadAvoided(): Boolean
open fun isTollRoadAvoided(@NonNull countryIso: String): Boolean
Returns if the toll roads should be avoided when computing the route.
Link copied to clipboard
open fun isUnpavedRoadAvoidable(@NonNull countryIso: String): Boolean
Returns if the unpaved roads can be avoided.
Link copied to clipboard
open fun isUnpavedRoadAvoided(): Boolean
open fun isUnpavedRoadAvoided(@NonNull countryIso: String): Boolean
Returns if the unpaved roads should be avoided when computing the route.
Link copied to clipboard
open fun isValidParcelable(): Boolean
If object after recreate from parcel contains all of reference like original object method return true.
Link copied to clipboard
open fun removeGeoPolylineAvoid(geoPolyline: GeoPolyline)
Removes the avoid of the specific GeoPolyline.
Link copied to clipboard
open fun removeGeoRectangleAvoid(geoBoundingBox: GeoBoundingBox)
Removes the avoid of the specific GeoBoundingBox.
Link copied to clipboard
open fun removeTrafficAvoid(traffic: TrafficInfo)
Removes the avoid of some traffic events.
Link copied to clipboard
open fun setBoatFerryAvoided(avoid: Boolean)
open fun setBoatFerryAvoided(@NonNull countryIso: String, avoid: Boolean)
Sets the flag indicates whether boat ferry should be avoided when computing the route.
Link copied to clipboard
open fun setCountryAvoided(@NonNull countryIso: String, avoid: Boolean)
Sets the flag indicates whether country should be avoided when computing the route.
Link copied to clipboard
open fun setDepartureTime(@Nullable departureTime: Date)
Sets the desired departure time Set to null to user current time
Link copied to clipboard
open fun setEmissionStandard(emissionStandard: Int)
Link copied to clipboard
open fun setGenerateExtendedInfo(generateExtendedInfo: Boolean)
Sets whether extended info should be generated
Link copied to clipboard
open fun setHazmatSettings(hazmatSettings: HazmatSettings)
Set hazmat cargo options
Link copied to clipboard
open fun setHighwayAvoided(avoid: Boolean)
open fun setHighwayAvoided(@NonNull countryIso: String, avoid: Boolean)
Sets the flag indicates whether highway should be avoided when computing the route.
Link copied to clipboard
open fun setMaxspeed(maxSpeed: Int)
Set the maximum speed, which a vehicle could achieve.
Link copied to clipboard
open fun setNAPStrategy(NAPStrategy: Int)
Sets NAP strategy to be used during route compute.
Link copied to clipboard
open fun setRoutingService(routingService: Int)
Sets the type of routing service for computing the route.
Link copied to clipboard
open fun setRoutingType(routingType: Int)
Sets the route computing type.
Link copied to clipboard
open fun setSpecialAreaAvoided(avoid: Boolean)
open fun setSpecialAreaAvoided(@NonNull countryIso: String, avoid: Boolean)
Sets the flag indicates whether special area should be avoided when computing the route.
Link copied to clipboard
open fun setTollRoadAvoided(avoid: Boolean)
open fun setTollRoadAvoided(@NonNull countryIso: String, avoid: Boolean)
Sets the flag indicates whether toll roads should be avoided when computing the route.
Link copied to clipboard
open fun setTransportMode(transportMode: Int)
Sets the type of transport for computing the route.
Link copied to clipboard
open fun setTurnPreference(turnPreference: Int)
Link copied to clipboard
open fun setUnpavedRoadAvoided(avoid: Boolean)
open fun setUnpavedRoadAvoided(@NonNull countryIso: String, avoid: Boolean)
Sets the flag indicates whether unpaved roads should be avoided when computing the route.
Link copied to clipboard
open fun setURLOverride(@Nullable urlOverride: String)
Set default online routing URL override.
Link copied to clipboard
open fun setUseEndpointProtection(value: Boolean)
If this option is enabled some restrictions in vicinity of endpoints are relaxed.
Link copied to clipboard
open fun setUseSpeedProfiles(useSpeedProfiles: Boolean)
Sets whether speed profiles should be used when computing route
Link copied to clipboard
open fun setVehicleFuelType(fuelType: Int)
Link copied to clipboard
open fun setVehicleManufacturingYear(yearManufactured: Int)
Set the year when the vehicle was manufactured
Link copied to clipboard
open fun toString(): String
Link copied to clipboard
open fun useEndpointProtection(): Boolean
Returns whether routing is allowed to break restrictions in vicinity of start, via or end point if no restriction-free route exists.
Link copied to clipboard
open fun useSpeedProfiles(): Boolean
Returns whether speed profiles are used when computing route
Link copied to clipboard
open fun writeToParcel(dest: Parcel, flags: Int)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard