Класс QGeoRoutingManagerEngine

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

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

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

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

Сигналы

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

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

Подклассы 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 для передачи любых данных, специфичных для реализации, движку.

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

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

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

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

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

void QGeoRoutingManagerEngine::finished(QGeoRouteReply *reply)

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

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

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

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

QGeoRoutingManagerEngine::~QGeoRoutingManagerEngine()

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

QGeoRouteReply *QGeoRoutingManagerEngine::calculateRoute(const QGeoRouteRequest &request)

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

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

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

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

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

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