sdk-routing / com.tomtom.online.sdk.routing.data / RouteSection

RouteSection

open class RouteSection : Serializable

A set of attributes describing route developer properties.

Constructors

<init>

RouteSection()

Empty constructor for the RouteSection.

RouteSection(startPointIndex: Int, endPointIndex: Int, travelMode: String!, countryCode: String!, sectionType: String!, simpleCategory: String!, effectiveSpeedInKmh: Int, delayInSeconds: Int, magnitudeOfDelay: Int, tec: Tec!)

Default constructor for RouteSection

Properties

countryCode

var countryCode: String!

A 3-character ISO 3166-1 alpha-3 country code.

delayInSeconds

var delayInSeconds: Int

The delay in seconds caused by the incident.

effectiveSpeedInKmh

var effectiveSpeedInKmh: Int

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

endPointIndex

var endPointIndex: Int

Index of the last point (offset 0) in the route this section applies to (only included for routeRepresentation polyline).

magnitudeOfDelay

var magnitudeOfDelay: Int

The magnitude of delay caused by the incident.

sectionType

var sectionType: String!

Specifies which of the section types is reported in the route Response.

simpleCategory

var simpleCategory: String!

Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER.

startPointIndex

var startPointIndex: Int

Index of the first point (offset 0) in the route this section applies to (only included for routeRepresentation polyline).

tec

var tec: Tec!

The details of the traffic event.

travelMode

var travelMode: String!

This attribute is either set to the value given to the Request parameter travelMode, if this travel mode is possible, or to another which indicates that the given mode of transport is not possible in this section. This field can only be used within sections of type TRAVEL_MODE.

Functions

getCountryCode

open fun getCountryCode(): String!

Returns a 3-character ISO 3166-1 alpha-3 country code.

getDelayInSeconds

open fun getDelayInSeconds(): Int

Returns the delay in seconds caused by the incident.

getEffectiveSpeedInKmh

open fun getEffectiveSpeedInKmh(): Int

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

getEndPointIndex

open fun getEndPointIndex(): Int

Returns the index of the last point (offset 0) in the route this section applies to (only included for routeRepresentation polyline).

getMagnitudeOfDelay

open fun getMagnitudeOfDelay(): Int

Returns the magnitude of delay caused by the incident.

getSectionType

open fun getSectionType(): String!

Returns which of the section types is reported in the route response.

getSimpleCategory

open fun getSimpleCategory(): String!

Returns the type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER.

getStartPointIndex

open fun getStartPointIndex(): Int

Returns the index of the first point (offset 0) in the route this section applies to (only included for routeRepresentation polyline).

getTec

open fun getTec(): Tec!

Returns the details of the traffic event.

getTravelMode

open fun getTravelMode(): String!

This attribute is either set to the value given to the request parameter travelMode, if this travel mode is possible, or to another which indicates that the given mode of transport is not possible in this section. This field can only be used within sections of type TRAVEL_MODE.

toString

open fun toString(): String