sdk/com.sygic.sdk.route/RoutingOptions

RoutingOptions

open class RoutingOptions : BaseNativeParcelable

Class representing complex options available to route calculation.

Constructors

RoutingOptions

open fun RoutingOptions()

Default constructor.

RoutingOptions

open fun RoutingOptions(@NonNull original: RoutingOptions)

Copy constructor

Types

EuropeanEmissionStandard

@Retention(value = RetentionPolicy.CLASS)

annotation class EuropeanEmissionStandard

NearestAccessiblePointStrategy

@Retention(value = RetentionPolicy.CLASS)

annotation class NearestAccessiblePointStrategy

Represents values describing different Nearest Accessible Point (NAP) settings.

PreferredRoad

@Retention(value = RetentionPolicy.CLASS)

annotation class PreferredRoad

Represents values describing preferred road for various Truck Combinations/Truck Trains.

RouteAvoid

@Retention(value = RetentionPolicy.CLASS)

annotation class RouteAvoid

Shows values describing routing options that can be used to enforce special conditions on a calculated route.

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.

TurnPreference

@Retention(value = RetentionPolicy.CLASS)

annotation class TurnPreference

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.

addGeoRectangleAvoid

open fun addGeoRectangleAvoid(geoBoundingBox: GeoBoundingBox)

Set to avoid specific GeoBoundingBox.

addTrafficAvoid

open fun addTrafficAvoid(traffic: TrafficInfo)

Set to avoid some traffic events.

arriveInDrivingSide

open fun arriveInDrivingSide(): Boolean

Returns whether routing should finish on endpoint's side of road

describeContents

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

getConsumptionData

@NonNull

open fun getConsumptionData(): ConsumptionData

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.

getGeoRectangleAvoids

open fun getGeoRectangleAvoids(): List<GeoBoundingBox>

Get geo rectangles to be avoided.

getHazmatSettings

@NonNull

open fun getHazmatSettings(): HazmatSettings

Get current hazmat cargo options

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.

getPreferredRoad

open fun getPreferredRoad(): Int

getRouteAvoids

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

Returns all avoid for all countries.

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.

getTrailerAxles

open fun getTrailerAxles(): Int

getTrailerCount

open fun getTrailerCount(): Int

getTransportMode

open fun getTransportMode(): Int

Returns the type of transport for computing the route.

getTurnPreference

open fun getTurnPreference(): Int

getURLOverride

@Nullable

open fun getURLOverride(): String

Return override for default online routing URL.

getVehicleAxles

open fun getVehicleAxles(): 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

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

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

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

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

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 return true.

removeGeoPolylineAvoid

open fun removeGeoPolylineAvoid(geoPolyline: GeoPolyline)

Removes the avoid of the specific GeoPolyline.

removeGeoRectangleAvoid

open fun removeGeoRectangleAvoid(geoBoundingBox: GeoBoundingBox)

Removes the avoid of the specific GeoBoundingBox.

removeTrafficAvoid

open fun removeTrafficAvoid(traffic: TrafficInfo)

Removes the avoid of some traffic events.

setArriveInDrivingSide

open fun setArriveInDrivingSide(arriveInDrivingSide: Boolean)

Sets whether routing should finish on endpoint's side of road

setBoatFerryAvoided

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.

setConsumptionData

open fun setConsumptionData(consumptionData: ConsumptionData)

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 time Set 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

setHazmatSettings

open fun setHazmatSettings(hazmatSettings: HazmatSettings)

Set hazmat cargo options

setHighwayAvoided

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.

setMaxspeed

open fun setMaxspeed(maxSpeed: Int)

Set the maximum speed, which a vehicle could achieve.

setNAPStrategy

open fun setNAPStrategy(NAPStrategy: Int)

Sets NAP strategy to be used during route compute.

setPreferredRoad

open fun setPreferredRoad(preferredRoad: Int)

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)

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)

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

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

setTrailerAxles

open fun setTrailerAxles(axles: Int)

setTrailerCount

open fun setTrailerCount(trailerCount: Int)

setTransportMode

open fun setTransportMode(transportMode: Int)

Sets the type of transport for computing the route.

setTurnPreference

open fun setTurnPreference(turnPreference: Int)

setUnpavedRoadAvoided

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.

setURLOverride

open fun setURLOverride(@Nullable urlOverride: String)

Set default online routing URL override.

setUseEndpointProtection

open fun setUseEndpointProtection(value: Boolean)

If this option is enabled some restrictions in vicinity of endpoints are relaxed.

setUseSpeedProfiles

open fun setUseSpeedProfiles(useSpeedProfiles: Boolean)

Sets whether speed profiles should be used when computing route

setVehicleAxles

open fun setVehicleAxles(axles: Int)

setVehicleFuelType

open fun setVehicleFuelType(fuelType: Int)

setVehicleManufacturingYear

open fun setVehicleManufacturingYear(yearManufactured: Int)

Set the year when the vehicle was manufactured

toString

open fun toString(): String

useEndpointProtection

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.

useSpeedProfiles

open fun useSpeedProfiles(): Boolean

Returns whether speed profiles are used when computing route

writeToParcel

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

Properties

CONTENTS_FILE_DESCRIPTOR

val CONTENTS_FILE_DESCRIPTOR: Int = 1

CREATOR

val CREATOR: Parcelable.Creator<RoutingOptions>

PARCELABLE_WRITE_RETURN_VALUE

val PARCELABLE_WRITE_RETURN_VALUE: Int = 1