com.tomtom.sdk.navigation:navigation-engines/com.tomtom.sdk.navigation.horizon.elements.street/StreetElement

StreetElement

class StreetElement(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val cityDistrict: String, val cityBlock: String, val streetName: String, val roadNumbers: List<String>, val neighborhood: String) : HorizonElement

Horizon element that contains data about a street.

To receive such elements in the horizon snapshot, specify StreetElementType in the horizon options that you register with the horizon engine:

val horizonOptions = HorizonOptions(
    elementTypes = listOf(StreetElementType, ...),
    ...
)

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

Constructors

constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, cityDistrict: String, cityBlock: String, streetName: String, roadNumbers: List<String>, neighborhood: String)

Properties

val cityBlock: String

City block. Empty string if not available.

val cityDistrict: String

City district. Empty string if not available.

open override val endOffset: Distance

End offset on the horizon path.

open override val id: Int

Identifier of this element.

val neighborhood: String

Neighborhood name. Empty string if not available.

open override val pathId: Int

Identifier of the horizon path to which this element belongs.

val roadNumbers: List<String>

Road numbers ordered by priority, from the highest to the lowest. Empty list if not available.

open override val startOffset: Distance

Start offset on the horizon path.

val streetName: String

Street name. Empty string if not available.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String