OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
navigation.geocoder_if.GeocoderIf Class Reference

Resolve a human-readable location query into ranked candidates. More...

Inherits Protocol.

Public Member Functions

tuple[GeocodeResult,...] geocode (self, str query, *int limit=5)
 Return ranked candidates for the query.
 
None close (self)
 Release owned resources.
 

Detailed Description

Resolve a human-readable location query into ranked candidates.

Member Function Documentation

◆ geocode()

tuple[GeocodeResult, ...] navigation.geocoder_if.GeocoderIf.geocode (   self,
str  query,
*int   limit = 5 
)

Return ranked candidates for the query.

Parameters
queryHuman-readable location query to resolve.
limitMaximum number of ranked candidates to return.
Returns
Ranked geocoding candidates.

The documentation for this class was generated from the following file: