Класс QGeoCodingManagerEngine
Класс QGeoCodingManagerEngine предоставляет интерфейс и удобные методы реализаторам плагинов QGeoServiceProvider, которые хотят добавить поддержку операций геокодирования. Подробнее...
| Заголовок: | #include <QGeoCodingManagerEngine> |
| qmake: | QT += location |
| С тех пор: | Qt 5.6 |
| Наследуется от: | QObject |
Этот класс был представлен в Qt 5.6.
Открытые функции
| QGeoCodingManagerEngine(const QVariantMap ¶meters, QObject *parent = nullptr) | |
| virtual | ~QGeoCodingManagerEngine() |
| virtual QGeoCodeReply * | geocode(const QGeoAddress &address, const QGeoShape &bounds) |
| virtual QGeoCodeReply * | geocode(const QString &address, int limit, int offset, const QGeoShape &bounds) |
| QLocale | locale() const |
| QString | managerName() const |
| int | managerVersion() const |
| virtual QGeoCodeReply * | reverseGeocode(const QGeoCoordinate &coordinate, const QGeoShape &bounds) |
| void | setLocale(const QLocale &locale) |
Сигналы
| void | error(QGeoCodeReply *reply, QGeoCodeReply::Error error, QString errorString = QString()) |
| void | finished(QGeoCodeReply *reply) |
Подробное описание
В реализации по умолчанию, supportsGeocoding() и supportsReverseGeocoding() возвращают false, в то время как geocode() и reverseGeocode() вызывают QGeoCodeReply::UnsupportedOptionError.
Если поставщик услуг поддерживает геокодирование, подкласс должен предоставить реализацию geocode() и вызвать setSupportsGeocoding(true) в какой-то момент времени до вызова geocode().
Аналогично, если поставщик услуг поддерживает обратное геокодирование, подкласс должен предоставить реализацию reverseGeocode() и вызвать setSupportsReverseGeocoding(true) в какой-то момент времени до вызова reverseGeocode().
Подкласс QGeoCodingManagerEngine часто использует подкласс QGeoCodeReply внутри, чтобы добавить любые данные, специфичные для движка (например, объект QNetworkReply для сетевых служб), в экземпляры QGeoCodeReply, используемые движком.
См. также QGeoCodingManager.
Документация по членам функций
QGeoCodingManagerEngine::QGeoCodingManagerEngine(const QVariantMap ¶meters, QObject *parent = nullptr)
Создает новый движок с указанным parent, используя parameters для передачи любых данных, специфичных для реализации, движку.
void QGeoCodingManagerEngine::error(QGeoCodeReply *reply, QGeoCodeReply::Error error, QString errorString = QString())
Этот сигнал излучается, когда в обработке reply была обнаружена ошибка. Скорее всего, последует сигнал QGeoCodingManagerEngine::finished().
Ошибка будет описана кодом ошибки error. Если errorString не пуста, она будет содержать текстовое описание ошибки.
Этот сигнал и QGeoCodeReply::error() будут излучены одновременно.
Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.
void QGeoCodingManagerEngine::finished(QGeoCodeReply *reply)
Этот сигнал излучается, когда обработка reply завершена.
Если reply::error() равно QGeoCodeReply::NoError, то обработка завершилась успешно.
Этот сигнал и QGeoCodeReply::finished() будут излучены одновременно.
Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.
QGeoCodingManagerEngine::~QGeoCodingManagerEngine()
Уничтожает этот движок.
QGeoCodeReply *QGeoCodingManagerEngine::geocode(const QGeoAddress &address, const QGeoShape &bounds)
Начинает геокодирование address. Геокодирование — это процесс поиска координаты, соответствующей заданному адресу.
Будет возвращен объект QGeoCodeReply, который может использоваться для управления операцией геокодирования и для возврата результатов операции.
Этот движок и возвращаемый объект QGeoCodeReply будут излучать сигналы, указывающие на завершение операции или возникновение ошибок.
Если supportsGeocoding() возвращает false, произойдёт QGeoCodeReply::UnsupportedOptionError.
После завершения операции, QGeoCodeReply::locations() можно использовать для получения результатов, которые будут состоять из списка объектов QGeoLocation. Эти объекты представляют собой комбинацию координат и данных адреса.
Данные адреса, возвращаемые в результатах, могут отличаться от address. Это обычно происходит, если бэкенд службы геокодирования использует другую каноническую форму адресов или если address был заполнен только частично.
Если bounds не пусто и является допустимым QGeoShape, оно будет использоваться для ограничения результатов теми, которые содержатся в bounds. Это особенно полезно, если address заполнен только частично, так как служба попытается геокодировать все совпадения для указанных данных.
Пользователь отвечает за удаление возвращённого объекта reply, хотя это можно сделать в слоте, подключённом к QGeoCodingManagerEngine::finished(), QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() или QGeoCodeReply::error() с помощью deleteLater().
QGeoCodeReply *QGeoCodingManagerEngine::geocode(const QString &address, int limit, int offset, const QGeoShape &bounds)
Начинает геокодирование для местоположения, соответствующего address.
Будет возвращен объект QGeoCodeReply, который можно использовать для управления операцией геокодирования и возврата результатов операции.
Этот движок и возвращаемый объект QGeoCodeReply будут излучать сигналы, указывающие на завершение операции или возникновение ошибок.
После завершения операции QGeoCodeReply::locations() можно использовать для получения результатов, которые будут состоять из списка объектов QGeoLocation. Эти объекты представляют собой комбинацию координат и данных адреса.
Если limit равно -1, будет возвращен весь набор результатов, в противном случае будет возвращено не более limit результатов.
Параметр offset используется для запроса к службе геокодирования не возвращать первые offset результатов.
Результаты limit и offset используются вместе для реализации постраничной навигации.
Если bounds не пусто и является допустимым QGeoShape, оно будет использоваться для ограничения результатов теми, которые содержатся в bounds.
Пользователь отвечает за удаление возвращаемого объекта ответа, хотя это можно сделать в слоте, подключенном к QGeoCodingManagerEngine::finished(), QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() или QGeoCodeReply::error() с помощью deleteLater().
QLocale QGeoCodingManagerEngine::locale() const
Возвращает используемый язык, который является подсказкой для этого менеджера геокодирования о том, какой язык использовать для результатов.
См. также setLocale().
QString QGeoCodingManagerEngine::managerName() const
Возвращает имя, которое эта реализация движка использует для различения себя от реализаций, предоставленных другими плагинами.
Сочетание managerName() и managerVersion() должно быть уникальным среди реализаций плагинов.
int QGeoCodingManagerEngine::managerVersion() const
Возвращает версию этой реализации движка.
Сочетание managerName() и managerVersion() должно быть уникальным среди реализаций плагинов.
[virtual] QGeoCodeReply *QGeoCodingManagerEngine::reverseGeocode(const QGeoCoordinate &coordinate, const QGeoShape &bounds)
Начинает обратное геокодирование coordinate. Обратное геокодирование — это процесс поиска адреса, соответствующего заданным координатам.
Будет возвращен объект QGeoCodeReply, который можно использовать для управления операцией обратного геокодирования и для возврата результатов операции.
Этот движок и возвращаемый объект QGeoCodeReply будут испускать сигналы, указывающие, завершилась ли операция или произошли ошибки.
Если supportsReverseGeocoding() возвращает false, произойдет QGeoCodeReply::UnsupportedOptionError.
В этот момент QGeoCodeReply::locations() можно использовать для получения результатов, которые будут состоять из списка объектов QGeoLocation. Эти объекты представляют собой комбинацию данных координат и адреса.
Данные координат, возвращенные в результатах, могут отличаться от coordinate. Это обычно происходит, если сервер обратного геокодирования смещает координаты, чтобы они были ближе к соответствующим адресам, или если сервер возвращает результаты на нескольких уровнях детализации.
Если обратный геокодирования сервер возвращает несколько результатов, они будут предоставлены в порядке убывания точности. Это обычно происходит, если сервер настроен на обратное геокодирование на нескольких уровнях детализации. Например, некоторые службы возвращают пары «адрес-координаты» для улиц, городов, штатов и стран.
Если bounds не равен null и является допустимой геометрической фигурой QGeoShape, она будет использоваться для ограничения результатов теми, которые находятся внутри bounds.
Пользователь отвечает за удаление возвращаемого объекта ответа, хотя это можно сделать в слоте, подключенном к QGeoCodingManagerEngine::finished(), QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() или QGeoCodeReply::error() с помощью deleteLater().
void QGeoCodingManagerEngine::setLocale(const QLocale &locale)
Устанавливает язык для использования этим менеджером в locale.
Если этот менеджер геокодирования поддерживает возвращение результатов на разных языках, они будут возвращены на языке locale.
Используемый язык по умолчанию — системный язык, если он не задан.
См. также locale().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qgeocodingmanagerengine.html