Класс QGeoRoutingManagerEngine

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

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

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

• 31 открытая функция, унаследованная от QObject

Сигналы

• 2 сигнала, унаследованные от QObject

Статические открытые члены

• 9 статических открытых членов, унаследованных от QObject

Защищенные функции

• 9 защищенных функций, унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject

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

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

Подклассы QGeoRoutingManagerEngine должны предоставить реализацию calculateRoute().

В реализации по умолчанию, supportsRouteUpdates() возвращает false, и updateRoute() возвращает объект QGeoRouteReply, содержащий QGeoRouteReply::UnsupportedOptionError.

Если служба маршрутизации поддерживает обновление маршрутов по мере их прохождения, подкласс должен предоставить реализацию updateRoute() и вызвать setSupportsRouteUpdates(true) в какой-то момент времени до вызова updateRoute().

Функция setSupportsRouteUpdates() — одна из нескольких функций, которые настраивают заявленные возможности движка. Если возможности движка отличаются от значений по умолчанию, следует использовать эти функции, чтобы заявленные возможности были точными.

Важно сделать это до вызова calculateRoute(), updateRoute() или любой из функций отчёт о возможностях, чтобы предотвратить неправильное или несогласованное поведение.

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

См. также QGeoRoutingManager.

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

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

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

[virtual] QGeoRoutingManagerEngine::~QGeoRoutingManagerEngine()

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

[pure virtual] QGeoRouteReply *QGeoRoutingManagerEngine::calculateRoute(const QGeoRouteRequest &request)

Начинает вычисление маршрута, заданного request.

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

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

После завершения операции, QGeoRouteReply::routes может быть использован для получения рассчитанного маршрута или маршрутов.

Если запрос включает функции, которые не поддерживаются этим движком, как сообщается методами в этом движке, то произойдёт ошибка QGeoRouteReply::UnsupportedOptionError.

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

[signal] void QGeoRoutingManagerEngine::error(QGeoRouteReply *reply, QGeoRouteReply::Error error, QString errorString = QString())

Этот сигнал испускается, когда в обработке reply была обнаружена ошибка. Скорее всего, последует сигнал QGeoRoutingManagerEngine::finished().

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

Этот сигнал и QGeoRouteReply::error() будут испущены одновременно.

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

[signal] void QGeoRoutingManagerEngine::finished(QGeoRouteReply *reply)

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

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

Этот сигнал и QGeoRouteReply::finished() будут испущены одновременно.

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

QLocale QGeoRoutingManagerEngine::locale() const

Возвращает используемый регион, указывающий этому менеджеру маршрутизации, какой язык использовать для адресов и инструкций.

См. также setLocale().

QString QGeoRoutingManagerEngine::managerName() const

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

Сочетание managerName() и managerVersion() должно быть уникальным среди реализаций плагинов.

int QGeoRoutingManagerEngine::managerVersion() const

Возвращает версию этой реализации движка.

Сочетание managerName() и managerVersion() должно быть уникальным среди реализаций плагинов.

QLocale::MeasurementSystem QGeoRoutingManagerEngine::measurementSystem() const

Возвращает систему измерения, используемую этим менеджером.

Если был вызван setMeasurementSystem(), то возвращаемое значение этой функции может отличаться от значения, возвращаемого locale().measurementSystem(). В этом случае возвращаемое значение этой функции будет использоваться менеджером.

См. также setMeasurementSystem() и setLocale().

void QGeoRoutingManagerEngine::setLocale(const QLocale &locale)

Устанавливает регион для использования этим менеджером в locale.

Если этот менеджер маршрутизации поддерживает возврат адресов и инструкций на разных языках, они будут возвращаться на языке locale.

Если этот параметр не установлен, используемый регион по умолчанию — системный регион.

См. также locale().

void QGeoRoutingManagerEngine::setMeasurementSystem(QLocale::MeasurementSystem system)

Устанавливает систему измерения, используемую этим менеджером, в system.

Система измерения может быть установлена независимо от региона. Функции setLocale() и эта функция устанавливают систему измерения. Значение, установленное последней вызванной функцией, будет использоваться.

См. также measurementSystem(), locale() и setLocale().

[protected] void QGeoRoutingManagerEngine::setSupportedFeatureTypes(QGeoRouteRequest::FeatureTypes featureTypes)

Устанавливает типы функций, которые этот движок может учитывать при планировании маршрута, в featureTypes.

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

См. также supportedFeatureTypes().

[protected] void QGeoRoutingManagerEngine::setSupportedFeatureWeights(QGeoRouteRequest::FeatureWeights featureWeights)

Устанавливает весовые коэффициенты, которые этот движок может применять к различным функциям при планировании маршрута, в featureWeights.

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

См. также supportedFeatureWeights().

[protected] void QGeoRoutingManagerEngine::setSupportedManeuverDetails(QGeoRouteRequest::ManeuverDetails maneuverDetails)

Устанавливает уровни детализации для манёвров навигации, которые может запросить этот движок, в maneuverDetails.

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

См. также supportedManeuverDetails().

[protected] void QGeoRoutingManagerEngine::setSupportedRouteOptimizations(QGeoRouteRequest::RouteOptimizations optimizations)

Устанавливает оптимизации маршрутов, поддерживаемые этим движком, в optimizations.

Подклассы должны использовать этот метод для правильного отчёта о возможностях движка. Если эта функция не используется, движок сообщит, что не поддерживает никаких оптимизаций маршрутов.

См. также supportedRouteOptimizations().

[protected] void QGeoRoutingManagerEngine::setSupportedSegmentDetails(QGeoRouteRequest::SegmentDetails segmentDetails)

Устанавливает уровни детализации для сегментов маршрута, которые может запросить этот движок, в segmentDetails.

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

См. также supportedSegmentDetails().

[protected] void QGeoRoutingManagerEngine::setSupportedTravelModes(QGeoRouteRequest::TravelModes travelModes)

Устанавливает типы способов передвижения, поддерживаемые этим движком, в travelModes.

Подклассы должны использовать этот метод для правильного отчёта о возможностях движка. Если эта функция не используется, движок сообщит, что не поддерживает никаких способов передвижения.

См. также supportedTravelModes().

QGeoRouteRequest::FeatureTypes QGeoRoutingManagerEngine::supportedFeatureTypes() const

Возвращает типы функций, которые этот движок может учитывать при планировании маршрута.

См. также setSupportedFeatureTypes().

QGeoRouteRequest::FeatureWeights QGeoRoutingManagerEngine::supportedFeatureWeights() const

Возвращает весовые коэффициенты, которые этот движок может применять к различным функциям при планировании маршрута.

См. также setSupportedFeatureWeights().

QGeoRouteRequest::ManeuverDetails QGeoRoutingManagerEngine::supportedManeuverDetails() const

Возвращает уровни детализации для манёвров навигации, которые может запросить этот движок.

См. также setSupportedManeuverDetails().

QGeoRouteRequest::RouteOptimizations QGeoRoutingManagerEngine::supportedRouteOptimizations() const

Возвращает оптимизации маршрутов, поддерживаемые этим движком.

См. также setSupportedRouteOptimizations().

QGeoRouteRequest::SegmentDetails QGeoRoutingManagerEngine::supportedSegmentDetails() const

Возвращает уровни детализации для маршрутных сегментов, которые может запросить этот движок.

См. также setSupportedSegmentDetails().

QGeoRouteRequest::TravelModes QGeoRoutingManagerEngine::supportedTravelModes() const

Возвращает режимы передвижения, поддерживаемые этим движком.

См. также setSupportedTravelModes().

[virtual] QGeoRouteReply *QGeoRoutingManagerEngine::updateRoute(const QGeoRoute &route, const QGeoCoordinate &position)

Начинает процесс обновления route на основе текущего положения position.

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

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

Если supportsRouteUpdates() возвращает false, произойдёт ошибка QGeoRouteReply::UnsupportedOptionError.

После завершения операции, QGeoRouteReply::routes можно использовать для получения обновлённого маршрута.

Возвращённый маршрут может полностью отличаться от исходного маршрута, особенно если position достаточно удалён от исходного маршрута. В противном случае маршрут будет похожим, хотя оставшееся время и расстояние будут обновлены, а любые сегменты исходного маршрута, которые были пройдены, будут удалены.

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