com.tomtom.sdk.navigation:navigation-engines/com.tomtom.sdk.navigation.horizon.elements.countryinformation/CountryInformationElement

CountryInformationElement

class CountryInformationElement(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val countryCodeIso3: String, val regionCode: String, val drivingSide: DrivingSide, val speedUnit: Speed.Unit, val regionalSpeedLimits: List<RegionalSpeedLimit>, val countryName: String, val regionName: String) : HorizonElement

Horizon element that contains data about a country.

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

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

Constructors

CountryInformationElement

constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, countryCodeIso3: String, regionCode: String, drivingSide: DrivingSide, speedUnit: Speed.Unit, regionalSpeedLimits: List<RegionalSpeedLimit>, countryName: String, regionName: String)

Properties

countryCodeIso3

val countryCodeIso3: String

ISO 3166-1 alpha-3 country code. For example: "USA" for the United States of America, or "NLD" for the Netherlands. Empty string if not available. See https://www.iso.org/obp/ui/#iso:std:iso:3166:-1:ed-4:v1:en for more details.

countryName

val countryName: String

Name of the country in the language of the current locale, as specified in com.tomtom.sdk.navigation.ConfigurationSnapshot. Empty string if not available.

drivingSide

val drivingSide: DrivingSide

Driving side for the country.

endOffset

open override val endOffset: Distance

End offset on the horizon path.

open override val id: Int

Identifier of this element.

pathId

open override val pathId: Int

Identifier of the horizon path to which this element belongs.

regionalSpeedLimits

val regionalSpeedLimits: List<RegionalSpeedLimit>

Speed limits defined for this region/state/country. Empty list if not available.

regionCode

val regionCode: String

Two-letter code for the first-level subdivision of a country that can be used in combination with the ISO 3166-1 alpha-2 country code to form the ISO 3166-2 code of the subdivision. For example: "ON" (ISO 3166-2: "CA-ON") for Ontario, or "ZE" (ISO 3166-2: "NL-ZE") for Zeeland. Empty string if not available. See https://www.iso.org/obp/ui/#iso:std:iso:3166:-2:ed-4:v1:en for more details.

regionName

val regionName: String

Name of the region/state in the language of the current locale, as specified in com.tomtom.sdk.navigation.ConfigurationSnapshot. Empty string if not available.

speedUnit

val speedUnit: Speed.Unit

Speed unit used in the country.

startOffset

open override val startOffset: Distance

Start offset on the horizon path.

Functions

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String