com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route.section.traffic/TrafficSection

TrafficSection

Represents a route section with a traffic event.

Constructors

constructor(sectionLocation: SectionLocation, routeOffset: Distance, length: Distance, simpleCategory: SimpleCategory = SimpleCategory.OTHER, effectiveSpeedInKmh: Int, delay: Duration, magnitudeOfDelay: MagnitudeOfDelay? = null, tec: Tec? = null, id: String? = null)

Constructs a TrafficSection object with the given parameters.

constructor(geometry: List<GeoPoint>, routeOffset: Distance, length: Distance, simpleCategory: SimpleCategory = SimpleCategory.OTHER, effectiveSpeedInKmh: Int, delay: Duration, magnitudeOfDelay: MagnitudeOfDelay? = null, tec: Tec? = null, id: String? = null)

Constructs a TrafficSection object with the given parameters.

constructor(sectionLocation: SectionLocation, routeOffset: Distance, length: Distance, simpleCategory: SimpleCategory = SimpleCategory.OTHER, effectiveSpeed: Speed, delay: Duration, magnitudeOfDelay: MagnitudeOfDelay? = null, tec: Tec? = null, id: String? = null)

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

Properties

delay

val delay: Duration

Duration of the delay caused by the incident.

effectiveSpeed

val effectiveSpeed: Speed

Effective speed of the incident, averaged over its entire length.

effectiveSpeedInKmh

val ~~effectiveSpeedInKmh~~: Int

Effective speed of the incident in km/h, averaged over its entire length.

geometry

open override val ~~geometry~~: List<GeoPoint>

List of GeoPoints representing the section.

var id: String?

ID of the traffic event from which the traffic section was created. This can be used to retrieve additional information about the traffic event. This might be empty if there is no traffic event directly associated, or if the route provider does not support traffic event IDs.

length

open override val length: Distance

Distance from the the start point to the end point of the sectionLocation.

magnitudeOfDelay

var magnitudeOfDelay: MagnitudeOfDelay?

Magnitude of delay caused by the incident.

routeOffset

open override val routeOffset: Distance

Distance from the start of the route to the start point of the sectionLocation.

sectionLocation

open override val sectionLocation: SectionLocation

Information about the location of a section on a route's geometry.

simpleCategory

var simpleCategory: SimpleCategory

Type of the incident.

tec

var tec: Tec?

Details of the traffic event.

Functions

component1

operator fun ~~component1~~(): List<GeoPoint>

Returns geometry property of the class.

component2

operator fun ~~component2~~(): Distance

Returns routeOffset property of the class.

component3

operator fun ~~component3~~(): Distance

Returns length property of the class.

component4

operator fun ~~component4~~(): SimpleCategory

Returns simpleCategory property of the class.

component5

operator fun ~~component5~~(): Int

Returns effectiveSpeedInKmh property of the class.

component6

operator fun ~~component6~~(): Duration

Returns delay property of the class.

component7

operator fun ~~component7~~(): MagnitudeOfDelay?

Returns magnitudeOfDelay property of the class.

component8

operator fun ~~component8~~(): Tec?

Returns tec property of the class.

component9

operator fun ~~component9~~(): String?

Returns id property of the class.

copy

fun ~~copy~~(geometry: List<GeoPoint> = this.geometry, routeOffset: Distance = this.routeOffset, length: Distance = this.length, simpleCategory: SimpleCategory = this.simpleCategory, effectiveSpeedInKmh: Int = this.effectiveSpeedInKmh, delay: Duration = this.delay, magnitudeOfDelay: MagnitudeOfDelay? = this.magnitudeOfDelay, tec: Tec? = this.tec, id: String? = this.id): TrafficSection

Creates a copy of the object, with the option to modify some of its properties.

equals

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

Indicates whether some other object is "equal to" this one.

hashCode

open override fun hashCode(): Int

Returns a hash code value for the object.

toString

open override fun toString(): String

Returns a string representation of the object.