Class: Loqate::Geocoding::Direction

Inherits:
Dry::Struct::Value
  • Object
show all
Defined in:
lib/loqate/geocoding/direction.rb

Overview

A result from the directions API call.

Instance Method Summary collapse

Instance Method Details

#action ⇒ String

The type of routing instruction.

Returns:

  • (String) 


21
 
# File 'lib/loqate/geocoding/direction.rb', line 21

attribute :action, Types::Strict::String

#description ⇒ String

Textual description of the routing instruction.

Returns:

  • (String) 


27
 
# File 'lib/loqate/geocoding/direction.rb', line 27

attribute :description, Types::Strict::String

#road ⇒ String

The name of the road to turn onto.

Returns:

  • (String) 


33
 
# File 'lib/loqate/geocoding/direction.rb', line 33

attribute :road, Types::Strict::String

#segment_number ⇒ Integer

A zero based counter indicating the row number.

Returns:

  • (Integer) 


9
 
# File 'lib/loqate/geocoding/direction.rb', line 9

attribute :segment_number, Types::Strict::Integer

#step_distance ⇒ Integer

The distance in metres for this part of the route.

Returns:

  • (Integer) 


45
 
# File 'lib/loqate/geocoding/direction.rb', line 45

attribute :step_distance, Types::Strict::Integer

#step_number ⇒ Integer

A zero based counter indicating the row number.

Returns:

  • (Integer) 


15
 
# File 'lib/loqate/geocoding/direction.rb', line 15

attribute :step_number, Types::Strict::Integer

#step_time ⇒ Integer

The time in seconds for this part of the route.

Returns:

  • (Integer) 


39
 
# File 'lib/loqate/geocoding/direction.rb', line 39

attribute :step_time, Types::Strict::Integer

#total_distance ⇒ Integer

The total distance in metres for the route.

Returns:

  • (Integer) 


57
 
# File 'lib/loqate/geocoding/direction.rb', line 57

attribute :total_distance, Types::Strict::Integer

#total_time ⇒ Integer

The total time in seconds for the route.

Returns:

  • (Integer) 


51
 
# File 'lib/loqate/geocoding/direction.rb', line 51

attribute :total_time, Types::Strict::Integer