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

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.

Constructors

RoadShield

constructor(fullRoadNumber: String, iconReference: IconReference?, shieldContent: String = "", affixes: List<String> = emptyList(), stateCode: String = "", countryCode: String = "")

Constructs a RoadShield object with the given parameters.

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

Properties

affixes

val affixes: List<String>

List of possible affixes that can be shown in addition to the shieldContent.

countryCode

val countryCode: String

The country code (ISO 3166-1 alpha-3) containing the shield.

fullRoadNumber

val fullRoadNumber: String

Full road number. Most road numbers have a 'letter' prefix, which is also included.

iconReference

val iconReference: IconReference

Transparent identifier of the shield which may be empty if the underlying data source does not support the mapping. It is used to retrieve the actual road shield icon from the com.tomtom.sdk.asset.RoadShieldIconProvider.

reference

val reference: String

Transparent identifier of the shield which may be empty if the underlying data source does not support the mapping.

shieldContent

val shieldContent: String

The road number as shown on the shield.

stateCode

val stateCode: String

The state code containing the shield (second part of an ISO 3166-2 identifier).