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

FullRoute

open class FullRoute : MatchingDataProvider, Serializable

A description of a route comprised of a list of legs.

Constructors

<init>

FullRoute()

Empty constructor for the FullRoute.

FullRoute(summary: Summary!, legs: Array<RouteLeg!>!, sections: Array<RouteSection!>!, guidance: RouteGuidance!)

Default constructor for the FullRoute.

Properties

guidance

var guidance: RouteGuidance!

Contains guidance related elements. This field is present only when guidance was requested and is available.

legs

var legs: Array<RouteLeg!>!

A description of a part of a route, comprised of a list of points. Each additional waypoint provided in the Request will result in an additional leg in the returned route.

sections

var sections: Array<RouteSection!>!

Available inside elements. Contains one or more elements. The inner structure of a element is given below.

summary

var summary: Summary!

A summary of a route.

tag

var tag: Any!

Keeps any object to serialize and restore after rotation. String is best for serialization.

Functions

asMatchingDataProvider

open fun asMatchingDataProvider(): MatchingDataProvider

Get route as MatchingDataProvider.

getCoordinates

open fun getCoordinates(): MutableList<LatLng!>

Get route points.

getGuidance

open fun getGuidance(): RouteGuidance!

Returns the guidance related elements.

getLegs

open fun getLegs(): Array<RouteLeg!>!

Returns a description of a part of a route, comprised of a list of points.

getSections

open fun getSections(): Array<RouteSection!>!

Returns available inside elements. Contains one or more elements. The inner structure of a element is given below.

getSummary

open fun getSummary(): Summary!

Returns a summary of a route.

getTag

open fun getTag(): Any!

Returns the currently set tag.

setTag

open fun setTag(tag: Any!): Unit

Sets a new tag.

toString

open fun toString(): String