navigation:engine/com.tomtom.sdk.navigation.guidance.instruction

Package-level declarations

Types

Link copied to clipboard
data class ArrivalGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val arrivalSide: ItineraryPointSide) : GuidanceInstruction

Guidance Instruction indicating arrival at the destination.

Link copied to clipboard
data class BorderCrossing(val fromCountry: CountryInfo, val toCountry: CountryInfo)

Indicates a border crossing between two countries.

Link copied to clipboard
data class BorderCrossingGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val borderCrossing: BorderCrossing) : GuidanceInstruction

Guidance Instruction indicating that a border between two countries will be crossed.

Link copied to clipboard
data class CountryInfo(val countryCode: String, val countryName: String)

Country information.

Link copied to clipboard
data class DepartureGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null) : GuidanceInstruction

Guidance Instruction indicating departure from the origin.

Link copied to clipboard
data class EnterAutoTransportGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val autoTransportType: AutoTransportType, val borderCrossing: BorderCrossing? = null) : GuidanceInstruction

Guidance Instruction indicating entering a vehicle transportation service through a terminal.

Link copied to clipboard
data class EnterCarpoolLaneGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val carpoolLaneDirection: CarpoolLaneDirection) : GuidanceInstruction

Guidance Instruction indicating entering a carpool lane by changing lanes.

Link copied to clipboard
data class ExitAutoTransportGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val autoTransportType: AutoTransportType, val borderCrossing: BorderCrossing? = null) : GuidanceInstruction

Guidance Instruction indicating exiting a vehicle transportation service through a terminal.

Link copied to clipboard
data class ExitCarpoolLaneGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val carpoolLaneDirection: CarpoolLaneDirection) : GuidanceInstruction

Guidance Instruction indicating exiting a carpool lane by changing lanes.

Link copied to clipboard
data class ExitHighwayGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val exitDirection: ExitDirection) : GuidanceInstruction

Guidance Instruction indicating taking a highway exit.

Link copied to clipboard
data class ExitRoundaboutGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val turnAngle: Angle, val exitNumber: Int? = null, val roundaboutDirection: RoundaboutDirection, val quantizedTurnAngle: QuantizedTurnAngle? = null) : GuidanceInstruction

Guidance Instruction indicating an exit from a roundabout.

Link copied to clipboard
data class FollowGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null) : GuidanceInstruction

Guidance Instruction indicating that the current road should be followed for some distance.

Link copied to clipboard
data class ForkGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val forkDirection: ForkDirection) : GuidanceInstruction

Guidance Instruction indicating an upcoming fork in the road.

Link copied to clipboard
interface GuidanceInstruction

Interface for a Guidance Instruction. Contains a set of attributes common to all GuidanceInstructions. e.g., 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

Link copied to clipboard
data class MandatoryTurnGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val turnAngle: Angle, val turnDirection: TurnDirection) : GuidanceInstruction

Guidance Instruction indicating a turn which is legally required.

Link copied to clipboard
data class MergeGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val mergeSide: MergeSide? = null) : GuidanceInstruction

Guidance Instruction indicating a merge onto another road.

Link copied to clipboard
data class RoadInformation(val roadName: String, val roadNumbers: List<String>, val roadShields: List<RoadShield>, val roadTypes: Set<RoadType> = emptySet())

Road information relating to a GuidanceInstruction.

Link copied to clipboard
data class RoundaboutGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val turnAngle: Angle, val exitNumber: Int? = null, val roundaboutDirection: RoundaboutDirection, val quantizedTurnAngle: QuantizedTurnAngle? = null) : GuidanceInstruction

Guidance Instruction indicating an upcoming roundabout.

Link copied to clipboard
data class Signpost(val exitNumber: String = "", val exitName: String = "", val towardName: String = "")

Signpost information for a GuidanceInstruction.

Link copied to clipboard
data class SwitchHighwayGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val exitDirection: ExitDirection) : GuidanceInstruction

Guidance Instruction indicating changing highways by following an exit ramp.

Link copied to clipboard
data class TollgateGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val tollgateName: String = "", val paymentTypes: Set<TollgatePaymentType> = emptySet()) : GuidanceInstruction

Guidance Instruction indicating an upcoming tollgate.

data class TurnAroundWhenPossibleGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null) : GuidanceInstruction

Guidance Instruction indicating the driver should turn around when it is possible.

Link copied to clipboard
data class TurnGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val turnAngle: Angle, val turnDirection: TurnDirection) : GuidanceInstruction

Guidance Instruction indicating a turn at a road junction.

Link copied to clipboard
data class WaypointGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val waypointSide: ItineraryPointSide) : GuidanceInstruction

Guidance Instruction indicating that a waypoint on the route is reached.