location/aws.sdk.kotlin.services.location.model/Leg

Leg

class Leg

Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

The StartPosition is the departure position.
The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

Types

Builder

class Builder

Companion

object Companion

Properties

distance

val distance: Double

The distance between the leg's StartPosition and EndPosition along a calculated route.

durationSeconds

val durationSeconds: Double

The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.

endPosition

val endPosition: List<Double>

The terminating position of the leg. Follows the format [longitude,latitude].

geometry

val geometry: LegGeometry?

Contains the calculated route's path as a linestring geometry.

startPosition

val startPosition: List<Double>

The starting position of the leg. Follows the format [longitude,latitude].

steps

val steps: List<Step>

Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.

Functions

copy

inline fun copy(block: Leg.Builder.() -> Unit = {}): Leg

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String