sdk-routing / com.tomtom.online.sdk.routing.route.information / Instruction

Instruction

@Beta(2020, 12) data class Instruction : Serializable

A set of attributes describing a maneuver, e.g., 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

Parameters

routeOffsetInMeters - The distance from the start of the route to the point of the instruction.

travelTimeInSeconds - The estimated travel time up to the point corresponding to routeOffsetInMeters.

point - A location of the maneuver defined as a latitude longitude pair.

instructionType - The type of the instruction, e.g., a turn or change of road form.

street - The street name of the next significant road segment after the maneuver, or of the street that should be followed.

roadNumbers - An aggregate for roadNumber elements.

exitNumber - The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by "," and possibly aggregated by "-", e.g., "10, 13-15".

countryCode - The 3-character ISO 3166-1 alpha-3 country code.

signpostText - The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.

junctionType - The type of the junction at which the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.

turnAngleInDecimalDegrees - Indicates the direction of an instruction.

roundaboutExitNumber - Indicates which exit to take at a roundabout.

isPossibleToCombineWithNext - It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right".

drivingSide - Indicates left-hand vs. right-hand side driving at the point of the maneuver.

maneuver - A code identifying the maneuver (e.g., 'Turn right').

message - A human-readable message for the maneuver.

combinedMessage - A human-readable message for the maneuver combined with the message from the next instruction.

Properties

combinedMessage

val combinedMessage: String?

A human-readable message for the maneuver combined with the message from the next instruction.

countryCode

val countryCode: String?

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

drivingSide

val drivingSide: String?

Indicates left-hand vs. right-hand side driving at the point of the maneuver.

exitNumber

val exitNumber: String?

The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by "," and possibly aggregated by "-", e.g., "10, 13-15".

instructionType

val instructionType: String?

The type of the instruction, e.g., a turn or change of road form.

isPossibleToCombineWithNext

val isPossibleToCombineWithNext: Boolean

It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right".

junctionType

val junctionType: String?

The type of the junction at which the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.

maneuver

val maneuver: String?

A code identifying the maneuver (e.g., 'Turn right').

message

val message: String?

A human-readable message for the maneuver.

point

val point: LatLng?

A location of the maneuver defined as a latitude longitude pair.

roadNumbers

val roadNumbers: List<String>

An aggregate for roadNumber elements.

roundaboutExitNumber

val roundaboutExitNumber: Int

Indicates which exit to take at a roundabout.

routeOffsetInMeters

val routeOffsetInMeters: Int

The distance from the start of the route to the point of the instruction.

signpostText

val signpostText: String?

The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.

street

val street: String?

The street name of the next significant road segment after the maneuver, or of the street that should be followed.

travelTimeInSeconds

val travelTimeInSeconds: Int

The estimated travel time up to the point corresponding to routeOffsetInMeters.

turnAngleInDecimalDegrees

val turnAngleInDecimalDegrees: Int

Indicates the direction of an instruction.