TomTom SDK for iOS PlaceMatch

PlaceMatch

public struct PlaceMatch

Describes the place details from reverse geocoding service.

  • The bounding box of the place match.

    Declaration

    Swift

    public let boundingBox: BoundingBox?

  • The geographical geometry of the place match, which can be visualized on a map.

    Declaration

    Swift

    public let geometry: Geometry?

  • Creates a new PlaceMatch.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public init(
    place: Place,
    navigablePosition: CLLocationCoordinate2D,
    matchType: MatchType?,
    geometry: Geometry? = nil,
    routeNumbers: [String] = [],
    speedLimit: Measurement<UnitSpeed>? = nil,
    boundingBox: BoundingBox? = nil
)

    Parameters

    place

    The result describing the reverse geocoded location.
    navigablePosition

    The position of the matched place.
    matchType

    The type of geographical object match, for example an address or a street.
    geometry

    The geographical geometry of the place match, which can be visualized on a map. The value is nil when ReverseGeocoderOptions.fetchGeometry is false.
    routeNumbers

    The route (or road) number, designation, or abbreviation is an identifying numeric (or alphanumeric) designation assigned by a highway authority to a particular stretch of roadway to distinguish it from other routes. Urban roads do not have route numbers, while extra-urban roads should have them available if they exist in the map data.
    speedLimit

    A speed limit defined at the matched road segment.
    boundingBox

    The bounding box of the place match.

  • Creates a new PlaceMatch.

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public init(
    place: Place,
    navigablePosition: CLLocationCoordinate2D,
    roadUse: Set<RoadUse>,
    matchType: MatchType?,
    geometry: Geometry? = nil,
    routeNumbers: [String] = [],
    speedLimit: Measurement<UnitSpeed>? = nil,
    boundingBox: BoundingBox? = nil
)

    Parameters

    place

    The result describing the reverse geocoded location.
    navigablePosition

    The position of the matched place.
    roadUse

    List of usages of the road.
    matchType

    The type of geographical object match, for example an address or a street.
    geometry

    The geographical geometry of the place match, which can be visualized on a map. The value is nil when ReverseGeocoderOptions.fetchGeometry is false.
    routeNumbers

    The route (or road) number, designation, or abbreviation is an identifying numeric (or alphanumeric) designation assigned by a highway authority to a particular stretch of roadway to distinguish it from other routes. Urban roads do not have route numbers, while extra-urban roads should have them available if they exist in the map data.
    speedLimit

    A speed limit defined at the matched road segment.
    boundingBox

    The bounding box of the place match.

  • The type of geographical object match, for example an address or a street.

    Declaration

    Swift

    public let matchType: MatchType?

  • The position of the matched place.

    Declaration

    Swift

    public let navigablePosition: CLLocationCoordinate2D

  • Representation of the address returned in the result.

    Declaration

    Swift

    public let place: Place

  • Set of road usage types at the address.

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public var roadUse: Set<RoadUse> { get }

  • The list of codes used to unambiguously identify the street.

    Declaration

    Swift

    public let routeNumbers: [String]

  • A speed limit if it is defined in the matched place.

    Declaration

    Swift

    public let speedLimit: Measurement<UnitSpeed>?