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

PlaceMatch

Describes detailed information about a location obtained through reverse geocoding.

Constructors

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

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

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.

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

copy

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

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

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