Class: Aws::GeoRoutes::Types::RouteWaypoint

Inherits:

Struct

• Object
• Struct
• Aws::GeoRoutes::Types::RouteWaypoint

Defined in:

gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb

Overview

Waypoint between the Origin and Destination.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:position]

Instance Attribute Summary

• #avoid_actions_for_distance ⇒ Integer

  Avoids actions for the provided distance.

• #avoid_u_turns ⇒ Boolean

  Avoid U-turns for calculation on highways and motorways.

• #heading ⇒ Float

  GPS Heading at the position.

• #matching ⇒ Types::RouteMatchingOptions

  Options to configure matching the provided position to the road network.

• #pass_through ⇒ Boolean

  If the waypoint should not be treated as a stop.

• #position ⇒ Array<Float>

  Position defined as [longitude, latitude].

• #side_of_street ⇒ Types::RouteSideOfStreetOptions

  Options to configure matching the provided position to a side of the street.

• #stop_duration ⇒ Integer

  Duration of the stop.

Instance Attribute Details

#avoid_actions_for_distance ⇒ Integer

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

Returns:

• (Integer)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#avoid_u_turns ⇒ Boolean

Avoid U-turns for calculation on highways and motorways.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#heading ⇒ Float

GPS Heading at the position.

Returns:

• (Float)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#matching ⇒ Types::RouteMatchingOptions

Options to configure matching the provided position to the road network.

Returns:

• (Types::RouteMatchingOptions)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#pass_through ⇒ Boolean

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#position ⇒ Array<Float>

Position defined as [longitude, latitude].

Returns:

• (Array<Float>)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#side_of_street ⇒ Types::RouteSideOfStreetOptions

Options to configure matching the provided position to a side of the street.

Returns:

• (Types::RouteSideOfStreetOptions)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end

#stop_duration ⇒ Integer

Duration of the stop.

Unit: seconds

Returns:

• (Integer)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 5893

class RouteWaypoint < Struct.new(
  :avoid_actions_for_distance,
  :avoid_u_turns,
  :heading,
  :matching,
  :pass_through,
  :position,
  :side_of_street,
  :stop_duration)
  SENSITIVE = [:position]
  include Aws::Structure
end