com.tomtom.sdk.location:model/com.tomtom.sdk.location

Package-level declarations

Types

data class Address(val streetNumber: String = "", val streetName: String = "", val municipalitySubdivision: String = "", val municipality: String = "", val countrySecondarySubdivision: String = "", val countryTertiarySubdivision: String = "", val countrySubdivision: String = "", val postalCode: String = "", val extendedPostalCode: String = "", val countryCode: String = "", val country: String = "", val countryCodeIso3: String = "", val freeformAddress: String = "", val countrySubdivisionName: String = "", val localName: String = "", val streetNameAndNumber: String = "", val postalName: String = "", val countrySubdivisionCode: String = "", val neighborhoodName: String = "")

Detailed address information.

DrivingSide

enum DrivingSide : Enum<DrivingSide>

Indicates driving side at the point of the maneuver.

EntryPoint

class EntryPoint(entryPointType: Set<EntryPointType>, val position: GeoPoint)

The Point Of Interest entry point.

EntryPointType

abstract class EntryPointType

Defines the type of a point-of-interest entry point.

EntryType

@JvmInline

value class ~~EntryType~~

Defines the type of the entrance.

GeoBias

data class GeoBias(val coordinate: GeoPoint, val radius: Distance)

Implementation of the GeoPoint with a radius.

GeoBoundingBox

data class GeoBoundingBox(val topLeft: GeoPoint, val bottomRight: GeoPoint)

Represents a bounding box for the map. It's defined in the WGS84 format.

GeoBounds

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

data class GeoBounds(val coordinates: List<GeoPoint>) : Parcelable

Represents geographical bounds determined by the given list of GeoPoint elements. The first and final GeoPoint are joined by a line segment that closes the bounds. Throws an IllegalArgumentException if the list of coordinates is empty.

GeoLineSegment

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

data class GeoLineSegment(val begin: GeoPoint, val end: GeoPoint)

Implementation of a line segment that represents a line between the two geographic coordinates.

GeoLocation

class GeoLocation(val position: GeoPoint, val accuracy: Distance? = null, val course: Angle? = null, val speed: Speed? = null, val altitude: Distance? = null, val time: Long = System.currentTimeMillis(), val elapsedRealtimeNanos: Long = SystemClock.elapsedRealtimeNanos(), val provider: String = DEFAULT_PROVIDER, val providerType: LocationProviderType = LocationProviderType.REALTIME, val extras: Bundle? = null)

Geographical representation of a certain location. It provides additional attributes like speed or bearing what can be useful in navigation applications.

GeoPoint

data class GeoPoint(@FloatRange(from = -90.0, to = 90.0) val latitude: Double, @FloatRange(from = -180.0, to = 180.0) val longitude: Double) : Parcelable

The implementation of geographic coordinates.

IconReference

@JvmInline

value class IconReference(reference: String)

Represents a road shield or exit sign icon reference.

LocationProviderType

enum LocationProviderType : Enum<LocationProviderType>

The source that provides the location.

PersonalLocationType

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class PersonalLocationType(val type: Int)

Type of a personal location.

Place

class Place

Represents a geographical location and its details.

RoadShield

class RoadShield(val fullRoadNumber: String, val shieldContent: String = "", val affixes: List<String> = emptyList(), val stateCode: String = "", val countryCode: String = "", val reference: String = "")

Represents a road shield: the distinctively shaped, colored sign used to identify a specific numbered road or route. Road shields are used across road classes, from major motorways down to national and regional roads, wherever a road carries a route number. These shapes serve as visual shorthand so that drivers do not need to read words while driving at high speeds. At a glance, the distinct outline of a shield helps drivers quickly understand which road they are on or need to follow.