com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route.instruction.arrival/ArrivalInstruction

ArrivalInstruction

class ArrivalInstruction(val arrivalSide: ItineraryPointRelativePosition, val routeOffset: Distance, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val announcements: List<Announcement> = emptyList(), val previousSignificantRoad: Road? = null, val nextSignificantRoad: Road? = null, val routePath: List<InstructionPoint> = emptyList(), val intersectionName: TextWithPhonetics? = null, val signpost: Signpost? = null, val landmark: Landmark? = null, val sideStreetOffset: Distance? = null, val trafficLightOffset: Distance? = null, val id: UniqueId = UniqueId()) : Instruction

Instruction indicating arrival at the destination.

Parameters

arrivalSide

Indicates the road side of the destination.

routeOffset

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

maneuverPoint

Location of the maneuver expressed as a GeoPoint.

drivingSide

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

combineWithNext

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

announcements

Fine-grained Announcements for the Instruction.

previousSignificantRoad

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

nextSignificantRoad

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

routePath

A List of InstructionPoints that represents a route path.

intersectionName

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

signpost

Signpost information, if present for this instruction.

landmark

Landmark information, if present in this instruction.

sideStreetOffset

Distance to the maneuver point from the intermediate side street, if any.

trafficLightOffset

Distance to the maneuver point from the preceding traffic light, if any.

id

The ID of the instruction.

See also

Constructors

Link copied to clipboard
constructor(arrivalSide: ItineraryPointRelativePosition, routeOffset: Distance, maneuverPoint: GeoPoint, drivingSide: DrivingSide, combineWithNext: Boolean, announcements: List<Announcement> = emptyList(), previousSignificantRoad: Road? = null, nextSignificantRoad: Road? = null, routePath: List<InstructionPoint> = emptyList(), intersectionName: TextWithPhonetics? = null, signpost: Signpost? = null, landmark: Landmark? = null, sideStreetOffset: Distance? = null, trafficLightOffset: Distance? = null, id: UniqueId = UniqueId())

Properties

Link copied to clipboard
open override val announcements: List<Announcement>
Link copied to clipboard
Link copied to clipboard
open override val combineWithNext: Boolean
Link copied to clipboard
open override val drivingSide: DrivingSide
Link copied to clipboard
open override val id: UniqueId
Link copied to clipboard
open override val intersectionName: TextWithPhonetics? = null
Link copied to clipboard
open override val landmark: Landmark? = null
Link copied to clipboard
open override val maneuverPoint: GeoPoint
Link copied to clipboard
open override val nextSignificantRoad: Road? = null
Link copied to clipboard
open override val previousSignificantRoad: Road? = null
Link copied to clipboard
open override val routeOffset: Distance
Link copied to clipboard
open override val routePath: List<InstructionPoint>
Link copied to clipboard
open override val sideStreetOffset: Distance? = null
Link copied to clipboard
open override val signpost: Signpost? = null
Link copied to clipboard
open override val trafficLightOffset: Distance? = null

Functions

Link copied to clipboard
Link copied to clipboard
operator fun component10(): TextWithPhonetics?
Link copied to clipboard
operator fun component11(): Signpost?
Link copied to clipboard
operator fun component12(): Landmark?
Link copied to clipboard
operator fun component13(): Distance?
Link copied to clipboard
operator fun component14(): Distance?
Link copied to clipboard
operator fun component15(): UniqueId
Link copied to clipboard
operator fun component2(): Distance
Link copied to clipboard
operator fun component3(): GeoPoint
Link copied to clipboard
operator fun component4(): DrivingSide
Link copied to clipboard
operator fun component5(): Boolean
Link copied to clipboard
operator fun component6(): List<Announcement>
Link copied to clipboard
operator fun component7(): Road?
Link copied to clipboard
operator fun component8(): Road?
Link copied to clipboard
operator fun component9(): List<InstructionPoint>
Link copied to clipboard
fun copy(arrivalSide: ItineraryPointRelativePosition = this.arrivalSide, routeOffset: Distance = this.routeOffset, maneuverPoint: GeoPoint = this.maneuverPoint, drivingSide: DrivingSide = this.drivingSide, combineWithNext: Boolean = this.combineWithNext, announcements: List<Announcement> = this.announcements, previousSignificantRoad: Road? = this.previousSignificantRoad, nextSignificantRoad: Road? = this.nextSignificantRoad, routePath: List<InstructionPoint> = this.routePath, intersectionName: TextWithPhonetics? = this.intersectionName, signpost: Signpost? = this.signpost, landmark: Landmark? = this.landmark, sideStreetOffset: Distance? = this.sideStreetOffset, trafficLightOffset: Distance? = this.trafficLightOffset, id: UniqueId = this.id): ArrivalInstruction
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String