com.tomtom.sdk.maps:map-display-api/com.tomtom.sdk.map.display.traffic/TrafficIncidentPoi

TrafficIncidentPoi

data class TrafficIncidentPoi : TrafficIncident

Describes the traffic incident poi.

Properties

open override val clustered: Int?

The ID of the parent cluster. Presence indicates whether the incident is clustered.

val clusterId: Int?

If present, indicates the ID of the cluster.

val clusterSize: Int?

The number of incidents within a cluster.

communityAttributes

open override val communityAttributes: CommunityAttributes

Specifies user reported attributes associated with the TrafficIncident.

open override val delay: Duration

The delay caused by the incident (except in road closures - in this case no delay provided). It is calculated against free-flow travel time (the travel time when the traffic is minimal, e.g., night traffic).

open override val descriptions: List<Description>

A description of the incident with the corresponding icon category and cause. Clustering - the idea of clustering is a grouping of all overlapping incidents. If all incidents in the cluster belong to the same type, it will return the incident's type icon. Otherwise, it will return the cluster icon.

open override val endDate: Date?

Estimated end date of the incident, when available.

open override val id: String?

The ID of the traffic incident.

leftHandTraffic

open override val leftHandTraffic: Boolean?

This indicates that if the road has left-hand traffic.

open override val magnitude: Magnitude?

The Magnitude of delay associated with the incident.

val poiType: PoiType

The beginning of incidents is described as PoiType.Start. If the traffic incident has no geometry, it is described as PoiType.Standalone.

open override val roadCoverage: RoadCoverage?

Describes if the traffic is assigned to the whole road (one way road), or only to one side (two-way road).

open override val roadType: RoadType?

Describes the RoadType.