Class: Couchbase::Cluster::SearchSort::SearchSortGeoDistance

Inherits:

Couchbase::Cluster::SearchSort

• Object
• Couchbase::Cluster::SearchSort
• Couchbase::Cluster::SearchSort::SearchSortGeoDistance

Defined in:

lib/couchbase/search_options.rb

Instance Attribute Summary

• #desc ⇒ Boolean

  If descending order should be applied.

• #field ⇒ String readonly

  Name of the field to sort by.

• #latitude ⇒ Float readonly
• #longitude ⇒ Float readonly
• #unit ⇒ :meters, ...

Instance Method Summary

• #initialize(field, longitude, latitude) {|| ... } ⇒ SearchSortGeoDistance constructor

  A new instance of SearchSortGeoDistance.

Methods inherited from Couchbase::Cluster::SearchSort

field, geo_distance, id, score

Constructor Details

#initialize(field, longitude, latitude) {|| ... } ⇒ SearchSortGeoDistance

Returns a new instance of SearchSortGeoDistance.

Parameters:

• field (String) —

  field name

• longitude (Float)
• latitude (Float)

Yield Parameters:

• (SearchSortGeoDistance)

# File 'lib/couchbase/search_options.rb', line 1034

def initialize(field, longitude, latitude)
  @field = field
  @longitude = longitude
  @latitude = latitude
  yield self if block_given?
end

Instance Attribute Details

#desc ⇒ Boolean

Returns if descending order should be applied.

Returns:

• (Boolean) —

  if descending order should be applied

# File 'lib/couchbase/search_options.rb', line 1019

def desc
  @desc
end

#field ⇒ String (readonly)

Returns name of the field to sort by.

Returns:

• (String) —

  name of the field to sort by

# File 'lib/couchbase/search_options.rb', line 1016

def field
  @field
end

#latitude ⇒ Float (readonly)

Returns:

• (Float)

# File 'lib/couchbase/search_options.rb', line 1025

def latitude
  @latitude
end

#longitude ⇒ Float (readonly)

Returns:

• (Float)

# File 'lib/couchbase/search_options.rb', line 1022

def longitude
  @longitude
end

#unit ⇒ :meters, ...

Returns:

• (:meters, :miles, :centimeters, :millimeters, :kilometers, :nauticalmiles, :feet, :yards, :inch)

# File 'lib/couchbase/search_options.rb', line 1028

def unit
  @unit
end