Class: Loqate::Geocoding::Place

Inherits:

Dry::Struct::Value

• Object
• Dry::Struct::Value
• Loqate::Geocoding::Place

Defined in:

lib/loqate/geocoding/place.rb

Overview

A result from the API call to find the nearest places.

Instance Method Summary

• #distance ⇒ Float

  The distance in KM from the CentrePoint to this record.

• #latitude ⇒ Float

  The WGS84 latitude coordinate of the location.

• #location ⇒ String

  The postcode that is nearest to the given location.

• #longitude ⇒ Float

  The WGS84 longitude coordinate of the location.

Instance Method Details

#distance ⇒ Float

The distance in KM from the CentrePoint to this record.

Returns:

• (Float)

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

attribute :distance, Types::Coercible::Float

#latitude ⇒ Float

The WGS84 latitude coordinate of the location.

Returns:

• (Float)

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

attribute :latitude, Types::Coercible::Float

#location ⇒ String

The postcode that is nearest to the given location.

Returns:

• (String)

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

attribute :location, Types::Strict::String

#longitude ⇒ Float

The WGS84 longitude coordinate of the location.

Returns:

• (Float)

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

attribute :longitude, Types::Coercible::Float