Class: Aws::LocationService::Types::Leg

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:end_position, :start_position]

Instance Attribute Summary collapse

Instance Attribute Details

#distance ⇒ Float

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

  • The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.

^

Returns:

  • (Float) 


3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3684

class Leg < Struct.new(
  :distance,
  :duration_seconds,
  :end_position,
  :geometry,
  :start_position,
  :steps)
  SENSITIVE = [:end_position, :start_position]
  include Aws::Structure
end

#duration_seconds ⇒ Float

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.

Returns:

  • (Float) 


3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3684

class Leg < Struct.new(
  :distance,
  :duration_seconds,
  :end_position,
  :geometry,
  :start_position,
  :steps)
  SENSITIVE = [:end_position, :start_position]
  include Aws::Structure
end

#end_position ⇒ Array<Float>

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

If the EndPosition isn't located on a road, it's snapped to a nearby road.

Returns:

  • (Array<Float>) 


3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3684

class Leg < Struct.new(
  :distance,
  :duration_seconds,
  :end_position,
  :geometry,
  :start_position,
  :steps)
  SENSITIVE = [:end_position, :start_position]
  include Aws::Structure
end

#geometry ⇒ Types::LegGeometry

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

Returns:



3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3684

class Leg < Struct.new(
  :distance,
  :duration_seconds,
  :end_position,
  :geometry,
  :start_position,
  :steps)
  SENSITIVE = [:end_position, :start_position]
  include Aws::Structure
end

#start_position ⇒ Array<Float>

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

If the StartPosition isn't located on a road, it's snapped to a nearby road.

Returns:

  • (Array<Float>) 


3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3684

class Leg < Struct.new(
  :distance,
  :duration_seconds,
  :end_position,
  :geometry,
  :start_position,
  :steps)
  SENSITIVE = [:end_position, :start_position]
  include Aws::Structure
end

#steps ⇒ Array<Types::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.

Returns:



3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3684

class Leg < Struct.new(
  :distance,
  :duration_seconds,
  :end_position,
  :geometry,
  :start_position,
  :steps)
  SENSITIVE = [:end_position, :start_position]
  include Aws::Structure
end