common:route/com.tomtom.sdk.common.route.instruction.highway/SwitchHighwayInstruction

SwitchHighwayInstruction

data class SwitchHighwayInstruction( val id: UniqueId = UniqueId(), val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoCoordinate, val junctionType: JunctionType? = null, val drivingSide: DrivingSide, val isPossibleToCombineWithNext: Boolean, val announcements: List<Announcement> = emptyList(), val maneuverType: Maneuver? = null, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val startPointIndex: Int = 0, val signpost: Signpost? = null, val exitDirection: ExitDirection? = null) : Instruction

Instruction indicating changing highways by following an exit ramp.

See also

com.tomtom.sdk.common.route.instruction.Instruction

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

Parameters

exitDirection

the direction of the exit, relative to the direction of travel, if available.

Constructors

SwitchHighwayInstruction

fun SwitchHighwayInstruction( id: UniqueId = UniqueId(), routeOffset: Distance, travelTime: Duration, maneuverPoint: GeoCoordinate, junctionType: JunctionType? = null, drivingSide: DrivingSide, isPossibleToCombineWithNext: Boolean, announcements: List<Announcement> = emptyList(), maneuverType: Maneuver? = null, previousSignificantRoad: RoadInformation? = null, nextSignificantRoad: RoadInformation? = null, routePath: List<RouteCoordinate> = emptyList(), intersectionName: String = "", startPointIndex: Int = 0, signpost: Signpost? = null, exitDirection: ExitDirection? = null)

Properties

open override val announcements: List<Announcement>

Fine-grained Announcements for the Instruction.

open override val drivingSide: DrivingSide

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

val exitDirection: ExitDirection? = null

open override val id: UniqueId

The ID of the instruction.

intersectionName

open override val intersectionName: String

Name of the intersection at the maneuver point, if present for this instruction.

isPossibleToCombineWithNext

open override val isPossibleToCombineWithNext: Boolean

Indicates if the instruction can be combined with the next one. This can be used to build messages like "Turn left and then turn right".

open override val junctionType: JunctionType? = null

Type of junction at which the maneuver takes place, if present for this instruction.

open override val maneuverPoint: GeoCoordinate

Location of the maneuver expressed as a GeoCoordinate.

open override val maneuverType: Maneuver? = null

Type of maneuver.

nextSignificantRoad

open override val nextSignificantRoad: RoadInformation? = null

Information about the road the driver will be on immediately after completing the maneuver, if available for this instruction.

previousSignificantRoad

open override val previousSignificantRoad: RoadInformation? = null

Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.

open override val routeOffset: Distance

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

open override val routePath: List<RouteCoordinate>

A List of RouteCoordinates that represents a route path.

open override val signpost: Signpost? = null

Signpost information, if present for this instruction.

startPointIndex

open override val startPointIndex: Int = 0

Index of the first point of the maneuver.

open override val travelTime: Duration

Estimated travel time to the point at routeOffset.