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

@Retention(value = RetentionPolicy.CLASS)

annotation class RoutingAlternatives

Represents values describing different routing types for alternative routes.

RoutingService

@Retention(value = RetentionPolicy.CLASS)

annotation class RoutingService

RoutingType

@Retention(value = RetentionPolicy.CLASS)

annotation class RoutingType

Represents values describing different routing types.

TransportMode

@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.

VehicleFuelType

@Retention(value = RetentionPolicy.CLASS)

annotation class VehicleFuelType

VehicleRestrictions

@Retention(value = RetentionPolicy.CLASS)

annotation class VehicleRestrictions

Functions

addDimensionalRestriction

open fun addDimensionalRestriction(restriction: Int, dimension: Int)

addGeoPolylineAvoid

open fun addGeoPolylineAvoid(geoPolyline: GeoPolyline)

Set to avoid specific GeoPolyline.

addRoadElementAvoid

open fun addRoadElementAvoid(element: RoadElement)

Set to avoid specific RoadElement.

addTrafficAvoid

open fun addTrafficAvoid(traffic: TrafficInfo)

Set to avoid some traffic events.

areDetoursSuppressed

open fun areDetoursSuppressed(): Boolean

Returns whether detours due to temporary closed roads are suppressed or not

describeContents

abstract fun describeContents(): Int

open fun describeContents(): Int

equals

open fun equals(o: Any): Boolean

generateExtendedInfo

open fun generateExtendedInfo(): Boolean

Returns whether extended info should be generated

getAvoidableCountries

open fun getAvoidableCountries(): Set<String>

Returns avoidable countries.

getAvoidedCountries

@NonNull()

open fun getAvoidedCountries(): List<String>

Returns countries which are avoided

getDepartureTime

@Nullable()

open fun getDepartureTime(): Date

Returns the desired departure timer

getDimensionalRestriction

open fun getDimensionalRestriction(restriction: Int): Int

getEmissionStandard

open fun getEmissionStandard(): Int

getGeoPolylineAvoids

open fun getGeoPolylineAvoids(): List<GeoPolyline>

Get geo polylines to be avoided.

getHazardousMaterialsClass

open fun getHazardousMaterialsClass(): Int

getMaxSpeed

open fun getMaxSpeed(): Int

Get the maximum speed, which a vehicle could achieve.

getNAPStrategy

open fun getNAPStrategy(): Int

Returns what option is used for NAP.

getRoadElementsAvoids

open fun getRoadElementsAvoids(): Set<RoadElement>

Get road elements to be avoided.

getRouteAvoids

open fun getRouteAvoids(): Map<String, Set<Integer>>

Returns all avoid for all countries.

getRoutingAlternatives

@NonNull()

open fun getRoutingAlternatives(): List<Integer>

Returns which alternative types of routes should be also calculated.

getRoutingService

open fun getRoutingService(): Int

Returns the type of routing service for computing the route.

getRoutingType

open fun getRoutingType(): Int

Returns the route computing type.

getTrafficAvoids

open fun getTrafficAvoids(): Set<TrafficInfo>

Get traffic events to be avoided.

getTransportMode

open fun getTransportMode(): Int

Returns the type of transport for computing the route.

getTunnelRestriction

open fun getTunnelRestriction(): Int

getVehicleFuelType

open fun getVehicleFuelType(): Int

getVehicleManufacturingYear

open fun getVehicleManufacturingYear(): Int

Get the year when the vehicle was manufactured

hashCode

open fun hashCode(): Int

isBoatFerryAvoidable

open fun isBoatFerryAvoidable(countryIso: String): Boolean

Returns if the boat ferry can be avoided.

isBoatFerryAvoided

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

open fun isCountryAvoidable(@NonNull() countryIso: String): Boolean

Returns if a country can be avoided.

isCountryAvoided

open fun isCountryAvoided(@NonNull() countryIso: String): Boolean

Returns if a country should be avoided when computing the route.

isHighwayAvoidable

open fun isHighwayAvoidable(@NonNull() countryIso: String): Boolean

Returns if the highway can be avoided.

isHighwayAvoided

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

open fun isSpecialAreaAvoidable(@NonNull() countryIso: String): Boolean

Returns if the special area can be avoided.

isSpecialAreaAvoided

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

open fun isTollRoadAvoidable(@NonNull() countryIso: String): Boolean

Returns if the toll roads can be avoided.

isTollRoadAvoided

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

open fun isUnpavedRoadAvoidable(@NonNull() countryIso: String): Boolean

Returns if the unpaved roads can be avoided.

isUnpavedRoadAvoided

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

open fun isValidParcelable(): Boolean

If object after recreate from parcel contains all of reference like original object method returntrue.

removeGeoPolylineAvoid

open fun removeGeoPolylineAvoid(geoPolyline: GeoPolyline)

Removes the avoid of the specific GeoPolyline.

removeRoadElementAvoid

open fun removeRoadElementAvoid(element: RoadElement)

Removes the avoid of the specific road elements.

removeTrafficAvoid

open fun removeTrafficAvoid(traffic: TrafficInfo)

Removes the avoid of some traffic events.

setBoatFerryAvoided

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

open fun setCountryAvoided(@NonNull() countryIso: String, avoid: Boolean)

Sets the flag indicates whether country should be avoided when computing the route.

setDepartureTime

open fun setDepartureTime(@Nullable() departureTime: Date)

Sets the desired departure timeSet to null to user current time

setEmissionStandard

open fun setEmissionStandard(emissionStandard: Int)

setGenerateExtendedInfo

open fun setGenerateExtendedInfo(generateExtendedInfo: Boolean)

Sets whether extended info should be generated

setHazardousMaterialsClass

open fun setHazardousMaterialsClass(hazMatClass: Int)

setHighwayAvoided

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

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

open fun setNAPStrategy(NAPStrategy: Int)

Sets NAP strategy to be used during route compute.

setRoutingAlternatives

open fun setRoutingAlternatives(@NonNull() routingAlternatives: List<Integer>)

Sets which alternative types of routes should be also calculated.

setRoutingService

open fun setRoutingService(routingService: Int)

Sets the type of routing service for computing the route.

setRoutingType

open fun setRoutingType(routingType: Int)

Sets the route computing type.

setSpecialAreaAvoided

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

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

open fun setTransportMode(transportMode: Int)

Sets the type of transport for computing the route.

setTunnelRestriction

open fun setTunnelRestriction(tunnelType: Int)

setUnpavedRoadAvoided

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

open fun setUseSpeedProfiles(useSpeedProfiles: Boolean)

Sets whether speed profiles should be used when computing route

setVehicleFuelType

open fun setVehicleFuelType(fuelType: Int)

setVehicleManufacturingYear

open fun setVehicleManufacturingYear(yearManufactured: Int)

Set the year when the vehicle was manufactured

suppressDetours

open fun suppressDetours(suppress: Boolean)

Suppress unnecessary detours on temporary closed roads when waiting for road to open is shorter than potential detour.

useSpeedProfiles

open fun useSpeedProfiles(): Boolean

Returns whether speed profiles are used when computing route

writeToParcel

abstract fun writeToParcel(p: Parcel, p1: Int)

open fun writeToParcel(dest: Parcel, flags: Int)

Properties

CREATOR

val CREATOR: Parcelable.Creator<RoutingOptions>