com.tomtom.sdk.search:reverse-geocoder/com.tomtom.sdk.search.reversegeocoder.model.location/PlaceMatch

PlaceMatch

Describes detailed information about a location obtained through reverse geocoding.

Constructors

constructor(place: Place, roadUse: Set<RoadUse> = emptySet(), matchType: MatchType? = null, geometry: Geometry? = null, routeNumbers: List<String> = emptyList(), speedLimit: Speed? = null, boundingBox: GeoBoundingBox? = null)

constructor(place: Place, matchType: MatchType? = null, geometry: Geometry? = null, routeNumbers: List<String> = emptyList(), speedLimit: Speed? = null, boundingBox: GeoBoundingBox? = null)

Properties

boundingBox

val boundingBox: GeoBoundingBox?

The bounding box that encompasses the matched location.

geometry

val geometry: Geometry?

The geographical geometry of the matched location, if available. This value is null when ReverseGeocoderOptions.fetchGeometry is set to false.

matchType

val matchType: MatchType?

Information indicating the type of match for the location. This value is null when the ReverseGeocoderOptions.areaTypes filter is not empty.

place

val place: Place

The location information resulting from reverse geocoding.

roadUse

val ~~roadUse~~: Set<RoadUse>

A set of road usage categories associated with the location.

routeNumbers

val routeNumbers: List<String>

A list of route numbers, designations, or abbreviations that identify a specific stretch of roadway, assigned by a highway authority. Urban roads might not have route numbers, while extra-urban roads should have them if present in the map data.

speedLimit

val speedLimit: Speed?

The speed limit applicable to the street, if available.

Functions

component1

operator fun ~~component1~~(): Place

Returns the first component of this PlaceMatch object, which is the location information resulting from reverse geocoding.

component2

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

Returns the second component of this PlaceMatch object, which is a set of road usage categories associated with the location.

component3

operator fun component3(): MatchType?

Returns the third component of this PlaceMatch object, which is information indicating the type of match for the location.

component4

operator fun ~~component4~~(): Geometry?

Returns the fourth component of this PlaceMatch object, which is the geographical geometry of the matched location, if available.

component5

operator fun ~~component5~~(): List<String>

Returns the fifth component of this PlaceMatch object, which is a list of route numbers, designations, or abbreviations that identify a specific stretch of roadway, assigned by a highway authority.

component6

operator fun ~~component6~~(): Speed?

Returns the sixth component of this PlaceMatch object, which is the speed limit applicable to the street, if available.

component7

operator fun ~~component7~~(): GeoBoundingBox?

Returns the seventh component of this PlaceMatch object, which is the bounding box that encompasses the matched location.

copy

fun copy(place: Place = this.place, matchType: MatchType? = this.matchType, geometry: Geometry? = this.geometry, routeNumbers: List<String> = this.routeNumbers, speedLimit: Speed? = this.speedLimit, boundingBox: GeoBoundingBox? = this.boundingBox): PlaceMatch

fun ~~copy~~(place: Place = this.place, roadUse: Set<RoadUse> = this.roadUse, matchType: MatchType? = this.matchType, geometry: Geometry? = this.geometry, routeNumbers: List<String> = this.routeNumbers, speedLimit: Speed? = this.speedLimit, boundingBox: GeoBoundingBox? = this.boundingBox): PlaceMatch

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