maps:display/com.tomtom.sdk.maps.display.traffic/TrafficIncidentPoi

TrafficIncidentPoi

data class TrafficIncidentPoi( val descriptions: List<Description>, val delay: Duration, val roadType: RoadType?, val leftHandTraffic: Boolean?, val magnitude: Magnitude?, val roadCoverage: RoadCoverage?, val poiType: PoiType, val clusterId: Int?, val clusterSize: Int?, val clustered: Int?, val endDate: Date?, val id: String?, val communityAttributes: CommunityAttributes) : TrafficIncident

Describes the traffic incident poi.

Parameters

poiType

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

clusterId

If present, indicates the ID of the cluster.

clusterSize

The number of incidents within a cluster.

Constructors

TrafficIncidentPoi

fun TrafficIncidentPoi( descriptions: List<Description>, delay: Duration, roadType: RoadType?, leftHandTraffic: Boolean?, magnitude: Magnitude?, roadCoverage: RoadCoverage?, poiType: PoiType, clusterId: Int?, clusterSize: Int?, clustered: Int?, endDate: Date?, id: String?, communityAttributes: CommunityAttributes)

Properties

clustered

open override val clustered: Int?

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

clusterId

val clusterId: Int?

clusterSize

val clusterSize: Int?

communityAttributes

open override val communityAttributes: CommunityAttributes

Specifies user reported attributes associated with the TrafficIncident.

delay

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).

descriptions

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.

endDate