Sorts by location in the hits. More...

#include <couchbase/search_sort_geo_distance.hxx>

Inheritance diagram for search_sort_geo_distance:

Public Member Functions
	search_sort_geo_distance (geo_point location, std::string field)

	search_sort_geo_distance (double latitude, double longitude, std::string field)

auto	descending (bool desc) -> search_sort_geo_distance &
	Set the sorting direction.

auto	unit (search_geo_distance_units unit) -> search_sort_geo_distance &
	Specifies the unit used for sorting.

auto	encode () const -> encoded_search_sort override

Public Member Functions inherited from search_sort
virtual	~search_sort ()=default

Additional Inherited Members
Protected Member Functions inherited from search_sort
	search_sort ()=default

	search_sort (bool descending)

Protected Attributes inherited from search_sort
std::optional< bool >	descending_ {}

Detailed Description

Sorts by location in the hits.

See also: https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects

Since: 1.0.0

Constructor & Destructor Documentation

◆ search_sort_geo_distance() [1/2]

search_sort_geo_distance	(	geo_point	location,
		std::string	field )

inline

◆ search_sort_geo_distance() [2/2]

search_sort_geo_distance	(	double	latitude,
		double	longitude,
		std::string	field )

inline

Member Function Documentation

◆ descending()

auto descending ( bool desc ) -> search_sort_geo_distance &

Set the sorting direction.

Parameters

desc	`true` for descending order, `false` for ascending

Returns: pointer to this

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ encode()

auto encode ( ) const -> encoded_search_sort

overridevirtual

Returns: encoded representation of the search facet.

Since: 1.0.0

Internal: Internal interface

Implements search_sort.

◆ unit()

auto unit ( search_geo_distance_units unit ) -> search_sort_geo_distance &

Specifies the unit used for sorting.