RoutingOptions

open class RoutingOptions : BaseNativeParcelable

Class representing complex options available to route calculation.

Constructors

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

Types

ADRTunnelType
Link copied to clipboard
annotation class ADRTunnelType
ADR Tunnel classification
EuropeanEmissionStandard
Link copied to clipboard
annotation class EuropeanEmissionStandard
HazardousMaterialsClass
Link copied to clipboard
annotation class HazardousMaterialsClass
NearestAccessiblePointStrategy
Link copied to clipboard
annotation class NearestAccessiblePointStrategy
Represents values describing different Nearest Accessible Point (NAP) settings.
RouteAvoid
Link copied to clipboard
annotation class RouteAvoid
Shows values describing routing options that can be used to enforce special conditions on a calculated route.Please note, that all of them can be only used with car transport mode.
RoutingAlternatives
Link copied to clipboard
annotation class RoutingAlternatives
Represents values describing different routing types for alternative routes.
RoutingService
Link copied to clipboard
annotation class RoutingService
RoutingType
Link copied to clipboard
annotation class RoutingType
Represents values describing different routing types.
TransportMode
Link copied to clipboard
annotation class TransportMode
Represents values describing different transport modes, the mode of transportation a person will be using to travel a route (e.g.
VehicleFuelType
Link copied to clipboard
annotation class VehicleFuelType
VehicleRestrictions
Link copied to clipboard
annotation class VehicleRestrictions

Functions

addDimensionalRestriction
Link copied to clipboard
open fun addDimensionalRestriction(restriction: Int, dimension: Int)
addGeoPolylineAvoid
Link copied to clipboard
open fun addGeoPolylineAvoid(geoPolyline: GeoPolyline)
Set to avoid specific GeoPolyline.
addRoadElementAvoid
Link copied to clipboard
open fun addRoadElementAvoid(element: RoadElement)
Set to avoid specific RoadElement.
addTrafficAvoid
Link copied to clipboard
open fun addTrafficAvoid(traffic: TrafficInfo)
Set to avoid some traffic events.
areDetoursSuppressed
Link copied to clipboard
open fun areDetoursSuppressed(): Boolean
Returns whether detours due to temporary closed roads are suppressed or not
describeContents
Link copied to clipboard
abstract fun describeContents(): Int
open fun describeContents(): Int
equals
Link copied to clipboard
open fun equals(o: Any): Boolean
generateExtendedInfo
Link copied to clipboard
open fun generateExtendedInfo(): Boolean
Returns whether extended info should be generated
getAvoidableCountries
Link copied to clipboard
open fun getAvoidableCountries(): Set<String>
Returns avoidable countries.
getAvoidedCountries
Link copied to clipboard
open fun getAvoidedCountries(): List<String>
Returns countries which are avoided
getDepartureTime
Link copied to clipboard
open fun getDepartureTime(): Date
Returns the desired departure timer
getDimensionalRestriction
Link copied to clipboard
open fun getDimensionalRestriction(restriction: Int): Int
getEmissionStandard
Link copied to clipboard
open fun getEmissionStandard(): Int
getGeoPolylineAvoids
Link copied to clipboard
open fun getGeoPolylineAvoids(): List<GeoPolyline>
Get geo polylines to be avoided.
getHazardousMaterialsClass
Link copied to clipboard
open fun getHazardousMaterialsClass(): Int
getMaxSpeed
Link copied to clipboard
open fun getMaxSpeed(): Int
Get the maximum speed, which a vehicle could achieve.
getNAPStrategy
Link copied to clipboard
open fun getNAPStrategy(): Int
Returns what option is used for NAP.
getRoadElementsAvoids
Link copied to clipboard
open fun getRoadElementsAvoids(): Set<RoadElement>
Get road elements to be avoided.
getRouteAvoids
Link copied to clipboard
open fun getRouteAvoids(): Map<String, Set<Integer>>
Returns all avoid for all countries.
getRoutingAlternatives
Link copied to clipboard
open fun getRoutingAlternatives(): List<Integer>
Returns which alternative types of routes should be also calculated.
getRoutingService
Link copied to clipboard
open fun getRoutingService(): Int
Returns the type of routing service for computing the route.
getRoutingType
Link copied to clipboard
open fun getRoutingType(): Int
Returns the route computing type.
getTrafficAvoids
Link copied to clipboard
open fun getTrafficAvoids(): Set<TrafficInfo>
Get traffic events to be avoided.
getTransportMode
Link copied to clipboard
open fun getTransportMode(): Int
Returns the type of transport for computing the route.
getTunnelRestriction
Link copied to clipboard
open fun getTunnelRestriction(): Int
getVehicleFuelType
Link copied to clipboard
open fun getVehicleFuelType(): Int
getVehicleManufacturingYear
Link copied to clipboard
open fun getVehicleManufacturingYear(): Int
Get the year when the vehicle was manufactured
hashCode
Link copied to clipboard
open fun hashCode(): Int
isBoatFerryAvoidable
Link copied to clipboard
open fun isBoatFerryAvoidable(countryIso: String): Boolean
Returns if the boat ferry can be avoided.
isBoatFerryAvoided
Link copied to clipboard
open fun isBoatFerryAvoided(): Boolean
Returns if the boat ferry should be avoided when computing the route.
open fun isBoatFerryAvoided(countryIso: String): Boolean
Returns if the boat ferry should be avoided when computing the route.
isCountryAvoidable
Link copied to clipboard
open fun isCountryAvoidable(@NonNull() countryIso: String): Boolean
Returns if a country can be avoided.
isCountryAvoided
Link copied to clipboard
open fun isCountryAvoided(@NonNull() countryIso: String): Boolean
Returns if a country should be avoided when computing the route.
isHighwayAvoidable
Link copied to clipboard
open fun isHighwayAvoidable(@NonNull() countryIso: String): Boolean
Returns if the highway can be avoided.
isHighwayAvoided
Link copied to clipboard
open fun isHighwayAvoided(): Boolean
Returns if the highway should be avoided when computing the route.
open fun isHighwayAvoided(@NonNull() countryIso: String): Boolean
Returns if the highway should be avoided when computing the route.
isSpecialAreaAvoidable
Link copied to clipboard
open fun isSpecialAreaAvoidable(@NonNull() countryIso: String): Boolean
Returns if the special area can be avoided.
isSpecialAreaAvoided
Link copied to clipboard
open fun isSpecialAreaAvoided(): Boolean
Returns if the special area should be avoided when computing the route.
open fun isSpecialAreaAvoided(@NonNull() countryIso: String): Boolean
Returns if the special area should be avoided when computing the route.
isTollRoadAvoidable
Link copied to clipboard
open fun isTollRoadAvoidable(@NonNull() countryIso: String): Boolean
Returns if the toll roads can be avoided.
isTollRoadAvoided
Link copied to clipboard
open fun isTollRoadAvoided(): Boolean
Returns if the toll roads should be avoided when computing the route.
open fun isTollRoadAvoided(@NonNull() countryIso: String): Boolean
Returns if the toll roads should be avoided when computing the route.
isUnpavedRoadAvoidable
Link copied to clipboard
open fun isUnpavedRoadAvoidable(@NonNull() countryIso: String): Boolean
Returns if the unpaved roads can be avoided.
isUnpavedRoadAvoided
Link copied to clipboard
open fun isUnpavedRoadAvoided(): Boolean
Returns if the unpaved roads should be avoided when computing the route.
open fun isUnpavedRoadAvoided(@NonNull() countryIso: String): Boolean
Returns if the unpaved roads should be avoided when computing the route.
isValidParcelable
Link copied to clipboard
open fun isValidParcelable(): Boolean
If object after recreate from parcel contains all of reference like original object method returntrue.
removeGeoPolylineAvoid
Link copied to clipboard
open fun removeGeoPolylineAvoid(geoPolyline: GeoPolyline)
Removes the avoid of the specific GeoPolyline.
removeRoadElementAvoid
Link copied to clipboard
open fun removeRoadElementAvoid(element: RoadElement)
Removes the avoid of the specific road elements.
removeTrafficAvoid
Link copied to clipboard
open fun removeTrafficAvoid(traffic: TrafficInfo)
Removes the avoid of some traffic events.
setBoatFerryAvoided
Link copied to clipboard
open fun setBoatFerryAvoided(avoid: Boolean)
Sets the flag indicates whether boat ferry should be avoided when computing the route.
open fun setBoatFerryAvoided(@NonNull() countryIso: String, avoid: Boolean)
Sets the flag indicates whether boat ferry should be avoided when computing the route.
setCountryAvoided
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.
setDepartureTime
Link copied to clipboard
open fun setDepartureTime(@Nullable() departureTime: Date)
Sets the desired departure timeSet to null to user current time
setEmissionStandard
Link copied to clipboard
open fun setEmissionStandard(emissionStandard: Int)
setGenerateExtendedInfo
Link copied to clipboard
open fun setGenerateExtendedInfo(generateExtendedInfo: Boolean)
Sets whether extended info should be generated
setHazardousMaterialsClass
Link copied to clipboard
open fun setHazardousMaterialsClass(hazMatClass: Int)
setHighwayAvoided
Link copied to clipboard
open fun setHighwayAvoided(avoid: Boolean)
Sets the flag indicates whether highway should be avoided when computing the route.
open fun setHighwayAvoided(@NonNull() countryIso: String, avoid: Boolean)
Sets the flag indicates whether highway should be avoided when computing the route.
setMaxspeed
Link copied to clipboard
open fun setMaxspeed(maxSpeed: Int)
Set the maximum speed, which a vehicle could achieve.Allowed values are in range [0, 255], 0 means no limit.
setNAPStrategy
Link copied to clipboard
open fun setNAPStrategy(NAPStrategy: Int)
Sets NAP strategy to be used during route compute.
setRoutingAlternatives
Link copied to clipboard
open fun setRoutingAlternatives(@NonNull() routingAlternatives: List<Integer>)
Sets which alternative types of routes should be also calculated.
setRoutingService
Link copied to clipboard
open fun setRoutingService(routingService: Int)
Sets the type of routing service for computing the route.
setRoutingType
Link copied to clipboard
open fun setRoutingType(routingType: Int)
Sets the route computing type.
setSpecialAreaAvoided
Link copied to clipboard
open fun setSpecialAreaAvoided(avoid: Boolean)
Sets the flag indicates whether special area should be avoided when computing the route.
open fun setSpecialAreaAvoided(@NonNull() countryIso: String, avoid: Boolean)
Sets the flag indicates whether special area should be avoided when computing the route.
setTollRoadAvoided
Link copied to clipboard
open fun setTollRoadAvoided(avoid: Boolean)
Sets the flag indicates whether toll roads should be avoided when computing the route.
open fun setTollRoadAvoided(@NonNull() countryIso: String, avoid: Boolean)
Sets the flag indicates whether toll roads should be avoided when computing the route.
setTransportMode
Link copied to clipboard
open fun setTransportMode(transportMode: Int)
Sets the type of transport for computing the route.
setTunnelRestriction
Link copied to clipboard
open fun setTunnelRestriction(tunnelType: Int)
setUnpavedRoadAvoided
Link copied to clipboard
open fun setUnpavedRoadAvoided(avoid: Boolean)
Sets the flag indicates whether unpaved roads should be avoided when computing the route.
open fun setUnpavedRoadAvoided(@NonNull() countryIso: String, avoid: Boolean)
Sets the flag indicates whether unpaved roads should be avoided when computing the route.
setUseSpeedProfiles
Link copied to clipboard
open fun setUseSpeedProfiles(useSpeedProfiles: Boolean)
Sets whether speed profiles should be used when computing route
setVehicleFuelType
Link copied to clipboard
open fun setVehicleFuelType(fuelType: Int)
setVehicleManufacturingYear
Link copied to clipboard
open fun setVehicleManufacturingYear(yearManufactured: Int)
Set the year when the vehicle was manufactured
suppressDetours
Link copied to clipboard
open fun suppressDetours(suppress: Boolean)
Suppress unnecessary detours on temporary closed roads when waiting for road to open is shorter than potential detour.
useSpeedProfiles
Link copied to clipboard
open fun useSpeedProfiles(): Boolean
Returns whether speed profiles are used when computing route
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p: Parcel, p1: Int)
open fun writeToParcel(dest: Parcel, flags: Int)

Properties

CREATOR
Link copied to clipboard
val CREATOR: Parcelable.Creator<RoutingOptions>