Класс QGeoCodingManagerEngine

Класс QGeoCodingManagerEngine предоставляет интерфейс и удобные методы для разработчиков плагинов QGeoServiceProvider, которые хотят добавить поддержку операций геокодирования. Подробнее...

Этот класс был представлен в Qt 5.6.

• Список всех членов, включая унаследованные

Открытые функции

Сигналы

Подробное описание

В реализации по умолчанию, supportsGeocoding() и supportsReverseGeocoding() возвращают false, а geocode() и reverseGeocode() вызывают QGeoCodeReply::UnsupportedOptionError.

Если поставщик услуг поддерживает геокодирование, подкласс должен предоставить реализацию geocode() и вызвать setSupportsGeocoding(true) в какой-то момент времени до вызова geocode().

Аналогично, если поставщик услуг поддерживает обратное геокодирование, подкласс должен предоставить реализацию reverseGeocode() и вызвать setSupportsReverseGeocoding(true) в какой-то момент времени до вызова reverseGeocode().

Подкласс QGeoCodingManagerEngine часто использует подкласс QGeoCodeReply для добавления данных, специфичных для движка (например, объекта QNetworkReply для сетевых сервисов) к экземплярам QGeoCodeReply, используемым движком.

См. также QGeoCodingManager.

Документация по функциям-членам

QGeoCodingManagerEngine::QGeoCodingManagerEngine(const QVariantMap &parameters, QObject *parent = nullptr)

Создаёт новый движок с указанным parent, используя parameters для передачи любых данных, специфичных для реализации, в движок.

[signal] void QGeoCodingManagerEngine::error(QGeoCodeReply *reply, QGeoCodeReply::Error error, QString errorString = QString())

Этот сигнал излучается, когда в обработке reply обнаружена ошибка. После этого, вероятно, последует сигнал QGeoCodingManagerEngine::finished().

Ошибка будет описана с помощью кода ошибки error. Если errorString не пуста, она будет содержать текстовое описание ошибки.

Этот сигнал и QGeoCodeReply::error() будут излучаться одновременно.

Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.

[signal] void QGeoCodingManagerEngine::finished(QGeoCodeReply *reply)

Этот сигнал излучается, когда обработка reply завершена.

Если reply::error() равно QGeoCodeReply::NoError, значит обработка завершилась успешно.

Этот сигнал и QGeoCodeReply::finished() будут излучаться одновременно.

Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.

[virtual] QGeoCodingManagerEngine::~QGeoCodingManagerEngine()

Уничтожает этот движок.

[virtual] QGeoCodeReply *QGeoCodingManagerEngine::geocode(const QGeoAddress &address, const QGeoShape &bounds)

Начинает геокодирование address. Геокодирование — это процесс поиска координат, соответствующих заданному адресу.

Будет возвращён объект QGeoCodeReply, который можно использовать для управления операцией геокодирования и получения результатов операции.

Этот движок и возвращённый объект QGeoCodeReply будут излучать сигналы, указывающие, завершается ли операция или возникают ли ошибки.

Если supportsGeocoding() возвращает false, возникнет QGeoCodeReply::UnsupportedOptionError.

После завершения операции, QGeoCodeReply::locations() можно использовать для получения результатов, которые будут состоять из списка объектов QGeoLocation. Эти объекты представляют собой комбинацию координат и данных адреса.

Данные адреса, возвращаемые в результатах, могут отличаться от address. Это обычно происходит, если сервер геокодирования использует другую каноническую форму адресов или если address был заполнен частично.

Если bounds не null и является допустимым QGeoShape, он будет использоваться для ограничения результатов теми, которые содержатся в bounds. Это особенно полезно, если address заполнен только частично, поскольку сервис попытается выполнить геокодирование всех совпадений для указанных данных.

Пользователь отвечает за удаление возвращённого объекта reply, хотя это можно сделать в слоте, подключённом к QGeoCodingManagerEngine::finished(), QGeoCodingManagerEngine::error(), QGeoCodeReply::finished() или QGeoCodeReply::error() с помощью deleteLater().

[virtual] 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 не null и является допустимым 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().