QGeoCodingManagerEngine¶
The
QGeoCodingManagerEngine
class provides an interface and convenience methods to implementers ofQGeoServiceProvider
plugins who want to provide support for geocoding operations. More…
Synopsis¶
Functions¶
def
locale
()def
managerName
()def
managerVersion
()def
setLocale
(locale)
Virtual functions¶
def
geocode
(address, bounds)def
geocode
(address, limit, offset, bounds)def
reverseGeocode
(coordinate, bounds)
Signals¶
Detailed Description¶
In the default implementation, supportsGeocoding() and supportsReverseGeocoding() returns false while
geocode()
andreverseGeocode()
causeUnsupportedOptionError
to occur.If the service provider supports geocoding the subclass should provide an implementation of
geocode()
and call setSupportsGeocoding(true) at some point in time beforegeocode()
is called.Similarly, if the service provider supports reverse geocoding the subclass should provide an implementation
reverseGeocode()
and call setSupportsReverseGeocoding(true) at some point in time beforereverseGeocode()
is called.A subclass of
QGeoCodingManagerEngine
will often make use of a subclass foQGeoCodeReply
internally, in order to add any engine-specific data (such as aQNetworkReply
object for network-based services) to theQGeoCodeReply
instances used by the engine.See also
- class PySide2.QtLocation.QGeoCodingManagerEngine(parameters[, parent=None])¶
- param parent:
- param parameters:
Constructs a new engine with the specified
parent
, usingparameters
to pass any implementation specific data to the engine.
- PySide2.QtLocation.QGeoCodingManagerEngine.error(reply, error[, errorString=""])¶
- Parameters:
reply –
PySide2.QtLocation.QGeoCodeReply
error –
Error
errorString – str
- PySide2.QtLocation.QGeoCodingManagerEngine.finished(reply)¶
- Parameters:
reply –
PySide2.QtLocation.QGeoCodeReply
- PySide2.QtLocation.QGeoCodingManagerEngine.geocode(address, bounds)¶
- Parameters:
address –
PySide2.QtPositioning.QGeoAddress
bounds –
PySide2.QtPositioning.QGeoShape
- Return type:
Begins the geocoding of
address
. Geocoding is the process of finding a coordinate that corresponds to a given address.A
QGeoCodeReply
object will be returned, which can be used to manage the geocoding operation and to return the results of the operation.This engine and the returned
QGeoCodeReply
object will emit signals indicating if the operation completes or if errors occur.If supportsGeocoding() returns false an
UnsupportedOptionError
will occur.Once the operation has completed,
locations()
can be used to retrieve the results, which will consist of a list ofQGeoLocation
objects. These objects represent a combination of coordinate and address data.The address data returned in the results may be different from
address
. This will usually occur if the geocoding service backend uses a different canonical form of addresses or ifaddress
was only partially filled out.If
bounds
is non-null and a validQGeoShape
it will be used to limit the results to those that are contained bybounds
. This is particularly useful ifaddress
is only partially filled out, as the service will attempt to geocode all matches for the specified data.The user is responsible for deleting the returned reply object, although this can be done in the slot connected to
finished()
,error()
,finished()
orerror()
withdeleteLater()
.
- PySide2.QtLocation.QGeoCodingManagerEngine.geocode(address, limit, offset, bounds)
- Parameters:
address – str
limit – int
offset – int
bounds –
PySide2.QtPositioning.QGeoShape
- Return type:
Begins geocoding for a location matching
address
.A
QGeoCodeReply
object will be returned, which can be used to manage the geocoding operation and to return the results of the operation.This engine and the returned
QGeoCodeReply
object will emit signals indicating if the operation completes or if errors occur.Once the operation has completed,
locations()
can be used to retrieve the results, which will consist of a list ofQGeoLocation
objects. These objects represent a combination of coordinate and address data.If
limit
is -1 the entire result set will be returned, otherwise at mostlimit
results will be returned.The
offset
parameter is used to ask the geocoding service to not return the firstoffset
results.The
limit
andoffset
results are used together to implement paging.If
bounds
is non-null and a validQGeoShape
it will be used to limit the results to those that are contained bybounds
.The user is responsible for deleting the returned reply object, although this can be done in the slot connected to
finished()
,error()
,finished()
orerror()
withdeleteLater()
.
- PySide2.QtLocation.QGeoCodingManagerEngine.locale()¶
- Return type:
Returns the locale used to hint to this geocoding manager about what language to use for the results.
See also
- PySide2.QtLocation.QGeoCodingManagerEngine.managerName()¶
- Return type:
str
Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.
The combination of and
managerVersion()
should be unique amongst plugin implementations.
- PySide2.QtLocation.QGeoCodingManagerEngine.managerVersion()¶
- Return type:
int
Returns the version of this engine implementation.
The combination of
managerName()
and should be unique amongst plugin implementations.
- PySide2.QtLocation.QGeoCodingManagerEngine.reverseGeocode(coordinate, bounds)¶
- Parameters:
coordinate –
PySide2.QtPositioning.QGeoCoordinate
bounds –
PySide2.QtPositioning.QGeoShape
- Return type:
Begins the reverse geocoding of
coordinate
. Reverse geocoding is the process of finding an address that corresponds to a given coordinate.A
QGeoCodeReply
object will be returned, which can be used to manage the reverse geocoding operation and to return the results of the operation.This engine and the returned
QGeoCodeReply
object will emit signals indicating if the operation completes or if errors occur.If supportsReverseGeocoding() returns false an
UnsupportedOptionError
will occur.At that point
locations()
can be used to retrieve the results, which will consist of a list ofQGeoLocation
objects. These objects represent a combination of coordinate and address data.The coordinate data returned in the results may be different from
coordinate
. This will usually occur if the reverse geocoding service backend shifts the coordinates to be closer to the matching addresses, or if the backend returns results at multiple levels of detail.If multiple results are returned by the reverse geocoding service backend they will be provided in order of specificity. This normally occurs if the backend is configured to reverse geocode across multiple levels of detail. As an example, some services will return address and coordinate pairs for the street address, the city, the state and the country.
If
bounds
is non-null and a validQGeoShape
it will be used to limit the results to those that are contained bybounds
.The user is responsible for deleting the returned reply object, although this can be done in the slot connected to
finished()
,error()
,finished()
orerror()
withdeleteLater()
.
- PySide2.QtLocation.QGeoCodingManagerEngine.setLocale(locale)¶
- Parameters:
locale –
PySide2.QtCore.QLocale
Sets the locale to be used by this manager to
locale
.If this geocoding manager supports returning the results in different languages, they will be returned in the language of
locale
.The locale used defaults to the system locale if this is not set.
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.