com.tomtom.sdk.search:reverse-geocoder/com.tomtom.sdk.search.reversegeocoder/ReverseGeocoderOptions

ReverseGeocoderOptions

Reverse Geocoding request options.

Reverse geocoding options are used to specify the parameters of a reverse geocoding request. They consist of a position and optional parameters such as heading, radius, roadUses, areaTypes, locale, preferClosestAccurateAddress, and fetchGeometry.

To specify reverse geocoding options, create an instance of ReverseGeocoderOptions class:

val reverseGeocoderOptions = ReverseGeocoderOptions(
  position = GeoPoint(52.377271, 4.909466),
  heading = Angle.Companion.degrees(90.0),
  radius = Distance.Companion.meters(1000.0),
  areaTypes = setOf(AreaType.Municipality),
  locale = Locale.ENGLISH,
  preferClosestAccurateAddress = false,
  fetchGeometry = false
)

Constructors

ReverseGeocoderOptions

constructor(position: GeoPoint, heading: Angle? = null, radius: Distance = DEFAULT_RADIUS, roadUses: Set<RoadUse> = emptySet(), areaTypes: Set<AreaType> = emptySet(), locale: Locale = Locale.getDefault(), preferClosestAccurateAddress: Boolean = false, fetchGeometry: Boolean = false)

Constructs a ReverseGeocoderOptions object with the given parameters.

constructor(position: GeoPoint, heading: Angle? = null, radius: Distance = DEFAULT_RADIUS, areaTypes: Set<AreaType> = emptySet(), locale: Locale = Locale.getDefault(), preferClosestAccurateAddress: Boolean = false, fetchGeometry: Boolean = false)

Constructs a ReverseGeocoderOptions object with the given parameters.

Types

Companion

object Companion

Properties

areaTypes

val areaTypes: Set<AreaType>

Filters results to specific geographical area types. When areaTypes is set, the parameters heading and roadUses are ignored.

fetchGeometry

val fetchGeometry: Boolean

Specifies if geometry shapes should be fetched for reverse geocoding results, where available.

heading

val heading: Angle?

The directional heading of the vehicle in degrees while traveling on a road segment. North is 0 degrees, East is 90 degrees, etc.

locale

val locale: Locale

The language used for displaying results. If not provided, the system default language is used.

position

val position: GeoPoint

The geographical coordinates to be translated into a human-readable address.

preferClosestAccurateAddress

val preferClosestAccurateAddress: Boolean

Determines whether the closest accurate address is preferred over the address with the closest navigable coordinates.

radius

val radius: Distance

The maximum distance from the specified position that the reverse geocoder will search within. Defaults to DEFAULT_RADIUS.

roadUses

val ~~roadUses~~: Set<RoadUse>

Filters results to roads with specific intended usages.

Functions

component1

operator fun ~~component1~~(): GeoPoint

Returns the first component of this ReverseGeocoderOptions object, which is the geographical coordinates.

component2

operator fun ~~component2~~(): Angle?

Returns the second component of this ReverseGeocoderOptions object, which is the directional heading of the vehicle in degrees while traveling on a road segment.

component3

operator fun ~~component3~~(): Distance

Returns the third component of this ReverseGeocoderOptions object, which is the maximum distance from the specified position that the reverse geocoder will search within. Defaults to DEFAULT_RADIUS.

component4

operator fun ~~component4~~(): Set<RoadUse>

Returns the fourth component of this ReverseGeocoderOptions object, which is a component that filters results to roads with specific intended usages.

component5

operator fun ~~component5~~(): Set<AreaType>

Returns the fifth component of this ReverseGeocoderOptions object, which is a component that filters results to specific geographical area types. When areaTypes is set, the parameters heading and roadUses are ignored.

component6

operator fun ~~component6~~(): Locale

Returns the sixth component of this ReverseGeocoderOptions object, which is the language used for displaying results. If not provided, the system default language is used.

component7

operator fun ~~component7~~(): Boolean

Returns the seventh component of this ReverseGeocoderOptions object, which determines whether the closest accurate address is preferred over the address with the closest navigable coordinates.

component8

operator fun ~~component8~~(): Boolean

Returns the eighth component of this ReverseGeocoderOptions object, which specifies if geometry shapes should be fetched for reverse geocoding results, where available.

copy

fun copy(position: GeoPoint = this.position, heading: Angle? = this.heading, radius: Distance = this.radius, areaTypes: Set<AreaType> = this.areaTypes, locale: Locale = this.locale, preferClosestAccurateAddress: Boolean = this.preferClosestAccurateAddress, fetchGeometry: Boolean = this.fetchGeometry): ReverseGeocoderOptions

fun ~~copy~~(position: GeoPoint = this.position, heading: Angle? = this.heading, radius: Distance = this.radius, roadUses: Set<RoadUse> = this.roadUses, areaTypes: Set<AreaType> = this.areaTypes, locale: Locale = this.locale, preferClosestAccurateAddress: Boolean = this.preferClosestAccurateAddress, fetchGeometry: Boolean = this.fetchGeometry): ReverseGeocoderOptions

Creates a copy of this ReverseGeocoderOptions object with optional parameter overrides.