Класс QGeoRouteRequest
Класс QGeoRouteRequest представляет параметры и ограничения, определяющие запрос на информацию о маршрутизации. Подробнее...
| Заголовок: | #include <QGeoRouteRequest> |
| qmake: | QT += location |
| С версии: | Qt 5.6 |
Открытые типы
| enum | FeatureType { NoFeature, TollFeature, HighwayFeature, PublicTransitFeature, ..., TrafficFeature } |
| flags | FeatureTypes |
| enum | FeatureWeight { NeutralFeatureWeight, PreferFeatureWeight, RequireFeatureWeight, AvoidFeatureWeight, DisallowFeatureWeight } |
| flags | FeatureWeights |
| enum | ManeuverDetail { NoManeuvers, BasicManeuvers } |
| flags | ManeuverDetails |
| enum | RouteOptimization { ShortestRoute, FastestRoute, MostEconomicRoute, MostScenicRoute } |
| flags | RouteOptimizations |
| enum | SegmentDetail { NoSegmentData, BasicSegmentData } |
| flags | SegmentDetails |
| enum | TravelMode { CarTravel, PedestrianTravel, BicycleTravel, PublicTransitTravel, TruckTravel } |
| flags | TravelModes |
Открытые функции
| QGeoRouteRequest(const QList<QGeoCoordinate> &waypoints = ...) | |
| QGeoRouteRequest(const QGeoCoordinate &origin, const QGeoCoordinate &destination) | |
| QGeoRouteRequest(const QGeoRouteRequest &other) | |
| ~QGeoRouteRequest() | |
| QList<QGeoRectangle> | excludeAreas() const |
| QVariantMap | extraParameters() const |
| QList<QGeoRouteRequest::FeatureType> | featureTypes() const |
| QGeoRouteRequest::FeatureWeight | featureWeight(QGeoRouteRequest::FeatureType featureType) const |
| QGeoRouteRequest::ManeuverDetail | maneuverDetail() const |
| int | numberAlternativeRoutes() const |
| QGeoRouteRequest::RouteOptimizations | routeOptimization() const |
| QGeoRouteRequest::SegmentDetail | segmentDetail() const |
| void | setExcludeAreas(const QList<QGeoRectangle> &areas) |
| void | setExtraParameters(const QVariantMap &extraParameters) |
| void | setFeatureWeight(QGeoRouteRequest::FeatureType featureType, QGeoRouteRequest::FeatureWeight featureWeight) |
| void | setManeuverDetail(QGeoRouteRequest::ManeuverDetail maneuverDetail) |
| void | setNumberAlternativeRoutes(int alternatives) |
| void | setRouteOptimization(QGeoRouteRequest::RouteOptimizations optimization) |
| void | setSegmentDetail(QGeoRouteRequest::SegmentDetail segmentDetail) |
| void | setTravelModes(QGeoRouteRequest::TravelModes travelModes) |
| void | setWaypoints(const QList<QGeoCoordinate> &waypoints) |
| void | setWaypointsMetadata(const QList<QVariantMap> &waypointMetadata) |
| QGeoRouteRequest::TravelModes | travelModes() const |
| QList<QGeoCoordinate> | waypoints() const |
| QList<QVariantMap> | waypointsMetadata() const |
| bool | operator!=(const QGeoRouteRequest &other) const |
| QGeoRouteRequest & | operator=(const QGeoRouteRequest &other) |
| bool | operator==(const QGeoRouteRequest &other) const |
Подробное описание
Класс QGeoRouteRequest представляет параметры и ограничения, определяющие запрос на информацию о маршрутизации.
Состояние по умолчанию экземпляра QGeoRouteRequest приведет к запросу на базовые сегменты маршрута и навигационные маневры, описывающие самый быстрый маршрут на автомобиле, который охватывает заданные точки маршрута.
Возможны значительные различия в функциях, поддерживаемых различными поставщиками информации о маршрутизации, или даже в функциях, поддерживаемых одним и тем же поставщиком, если используются разные уровни авторизации.
В QGeoRoutingManager есть несколько функций, которые можно использовать для проверки того, какие функции поддерживаются текущим поставщиком и уровнем авторизации.
См. также QGeoRoutingManager.
Документация по типу члена
enum QGeoRouteRequest::FeatureTypeflags QGeoRouteRequest::FeatureTypes
Определяет функцию, которая важна для планирования маршрута.
Эти значения будут использоваться в сочетании с QGeoRouteRequest::FeatureWeight для определения того, должны ли они быть частью маршрута или нет.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NoFeature |
0x00000000 |
Используется методом QGeoRoutingManager::supportedFeatureTypes() для указания того, что при планировании маршрута никакие объекты не будут учитываться. |
QGeoRouteRequest::TollFeature |
0x00000001 |
Учитывать платные дороги при планировании маршрута. |
QGeoRouteRequest::HighwayFeature |
0x00000002 |
Учитывать автомагистрали при планировании маршрута. |
QGeoRouteRequest::PublicTransitFeature |
0x00000004 |
Учитывать общественный транспорт при планировании маршрута. |
QGeoRouteRequest::FerryFeature |
0x00000008 |
Учитывать паромы при планировании маршрута. |
QGeoRouteRequest::TunnelFeature |
0x00000010 |
Учитывать тоннели при планировании маршрута. |
QGeoRouteRequest::DirtRoadFeature |
0x00000020 |
Учитывать грунтовые дороги при планировании маршрута. |
QGeoRouteRequest::ParksFeature |
0x00000040 |
Учитывать парки при планировании маршрута. |
QGeoRouteRequest::MotorPoolLaneFeature |
0x00000080 |
Учитывать полосы для автопарка при планировании маршрута. |
QGeoRouteRequest::TrafficFeature |
0x00000100 |
Учитывать текущую ситуацию на дорогах при планировании маршрута. С QtLocation 5.10 |
Тип FeatureTypes — это typedef для QFlags<FeatureType>. Он хранит комбинацию значений FeatureType, объединённых операцией ИЛИ.
enum QGeoRouteRequest::FeatureWeightflags QGeoRouteRequest::FeatureWeights
Определяет вес, который следует присвоить объекту при планировании маршрута.
Эти значения будут использоваться совместно с QGeoRouteRequest::Feature для определения, должны ли они входить в маршрут или нет.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NeutralFeatureWeight |
0x00000000 |
Наличие или отсутствие объекта не повлияет на планирование маршрута. |
QGeoRouteRequest::PreferFeatureWeight |
0x00000001 |
Маршруты, содержащие объект, будут предпочтительнее тех, которые его не содержат. |
QGeoRouteRequest::RequireFeatureWeight |
0x00000002 |
Будут рассмотрены только маршруты, содержащие объект; в противном случае маршрут не будет возвращён. |
QGeoRouteRequest::AvoidFeatureWeight |
0x00000004 |
Маршруты, не содержащие объект, будут предпочтительнее тех, которые его содержат. |
QGeoRouteRequest::DisallowFeatureWeight |
0x00000008 |
Будут рассмотрены только маршруты, не содержащие объект; в противном случае маршрут не будет возвращён. |
Тип FeatureWeights — это typedef для QFlags<FeatureWeight>. Он хранит комбинацию значений FeatureWeight, объединённых операцией ИЛИ.
enum QGeoRouteRequest::ManeuverDetailflags QGeoRouteRequest::ManeuverDetails
Определяет объём информации о манёврах, которая должна быть включена в маршрут.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NoManeuvers |
0x0000 |
Информация о манёврах не должна быть включена в маршрут. |
QGeoRouteRequest::BasicManeuvers |
0x0001 |
В маршрут будут включены базовые манёвры. Это будет включать QGeoManeuver::instructionText(). |
Тип ManeuverDetails — это typedef для QFlags<ManeuverDetail>. Он хранит комбинацию значений ManeuverDetail, объединённых операцией ИЛИ.
enum QGeoRouteRequest::RouteOptimizationflags QGeoRouteRequest::RouteOptimizations
Определяет тип оптимизации, применяемый при планировании маршрута.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::ShortestRoute |
0x0001 |
Минимизировать длину поездки. |
QGeoRouteRequest::FastestRoute |
0x0002 |
Минимизировать время поездки. |
QGeoRouteRequest::MostEconomicRoute |
0x0004 |
Минимизировать стоимость поездки. |
QGeoRouteRequest::MostScenicRoute |
0x0008 |
Максимизировать живописность поездки. |
Тип RouteOptimizations — это typedef для QFlags<RouteOptimization>. Он хранит комбинацию значений RouteOptimization, объединённых операцией ИЛИ.
enum QGeoRouteRequest::SegmentDetailflags QGeoRouteRequest::SegmentDetails
Определяет объём информации о сегментах маршрута, который должен быть включён в маршрут.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NoSegmentData |
0x0000 |
Данные о сегментах не должны быть включены в маршрут. Маршрут, запрошенный с таким уровнем детализации сегментов, инициализирует QGeoRouteSegment::path() как прямую линию между позициями предыдущего и следующего QGeoManeuver экземпляров. |
QGeoRouteRequest::BasicSegmentData |
0x0001 |
В маршрут будут включены базовые данные о сегментах. Это будет включать QGeoRouteSegment::path(). |
Тип SegmentDetails — это typedef для QFlags<SegmentDetail>. Он хранит комбинацию значений SegmentDetail, объединённых операцией ИЛИ.
enum QGeoRouteRequest::TravelModeflags QGeoRouteRequest::TravelModes
Определяет режимы передвижения, используемые для маршрута.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::CarTravel |
0x0001 |
Маршрут будет оптимизирован для водителя автомобиля. |
QGeoRouteRequest::PedestrianTravel |
0x0002 |
Маршрут будет оптимизирован для пешехода. |
QGeoRouteRequest::BicycleTravel |
0x0004 |
Маршрут будет оптимизирован для велосипедиста. |
QGeoRouteRequest::PublicTransitTravel |
0x0008 |
Маршрут будет оптимизирован для использования общественного транспорта. |
QGeoRouteRequest::TruckTravel |
0x0010 |
Маршрут будет оптимизирован для водителя грузовика. |
Тип TravelModes — это typedef для QFlags<TravelMode>. Он хранит комбинацию значений TravelMode, объединённых операцией ИЛИ.
Документация функций-членов
QGeoRouteRequest::QGeoRouteRequest(const QList<QGeoCoordinate> &waypoints = ...)
Создаёт запрос на вычисление маршрута через указанные координаты waypoints.
Маршрут будет проходить через объекты waypoints в заданном порядке.
QGeoRouteRequest::QGeoRouteRequest(const QGeoCoordinate &origin, const QGeoCoordinate &destination)
Создаёт запрос на вычисление маршрута между origin и destination.
QGeoRouteRequest::QGeoRouteRequest(const QGeoRouteRequest &other)
Создаёт объект запроса маршрута на основе содержимого other.
QGeoRouteRequest::~QGeoRouteRequest()
Удаляет запрос.
QList<QGeoRectangle> QGeoRouteRequest::excludeAreas() const
Возвращает области, через которые маршрут не должен проходить.
См. также setExcludeAreas().
QVariantMap QGeoRouteRequest::extraParameters() const
Возвращает дополнительные параметры, заданные для данного запроса маршрута.
Эта функция была добавлена в Qt 5.11.
См. также setExtraParameters().
END_OF_DOCUMENT_MARKERQList<QGeoRouteRequest::FeatureType> QGeoRouteRequest::featureTypes() const
Возвращает список объектов, которые будут учитываться при планировании маршрута. Объекты с весом NeutralFeatureWeight не будут возвращены.
QGeoRouteRequest::FeatureWeight QGeoRouteRequest::featureWeight(QGeoRouteRequest::FeatureType featureType) const
Возвращает вес, назначенный объекту featureType при планировании маршрута.
Если для featureType не был задан вес, будет возвращен NeutralFeatureWeight.
См. также setFeatureWeight().
QGeoRouteRequest::ManeuverDetail QGeoRouteRequest::maneuverDetail() const
Возвращает уровень детализации, который будет использоваться при представлении маршрутных маневров.
См. также setManeuverDetail().
int QGeoRouteRequest::numberAlternativeRoutes() const
Возвращает количество альтернативных маршрутов, которые будут запрошены.
См. также setNumberAlternativeRoutes().
QGeoRouteRequest::RouteOptimizations QGeoRouteRequest::routeOptimization() const
Возвращает критерии оптимизации, которые этот запрос указывает для использования при планировании маршрута.
См. также setRouteOptimization().
QGeoRouteRequest::SegmentDetail QGeoRouteRequest::segmentDetail() const
Возвращает уровень детализации, который будет использоваться при представлении маршрутных участков.
См. также setSegmentDetail().
void QGeoRouteRequest::setExcludeAreas(const QList<QGeoRectangle> &areas)
Устанавливает areas в качестве исключаемых областей, через которые маршрут не должен проходить.
См. также excludeAreas().
void QGeoRouteRequest::setExtraParameters(const QVariantMap &extraParameters)
Устанавливает дополнительные параметры extraParameters для запроса маршрута. Формат дополнительных параметров специфичен для плагина и документирован для каждого плагина.
Функция была добавлена в Qt 5.11.
См. также extraParameters().
void QGeoRouteRequest::setFeatureWeight(QGeoRouteRequest::FeatureType featureType, QGeoRouteRequest::FeatureWeight featureWeight)
Назначает вес featureWeight объекту featureType при планировании маршрута.
По умолчанию всем объектам назначается вес NeutralFeatureWeight.
Невозможно назначить вес для QGeoRouteRequest::NoFeature.
См. также featureWeight().
void QGeoRouteRequest::setManeuverDetail(QGeoRouteRequest::ManeuverDetail maneuverDetail)
Устанавливает уровень детализации для представления маршрутных маневров на maneuverDetail.
Значение по умолчанию — QGeoRouteRequest::BasicManeuvers.
См. также maneuverDetail().
void QGeoRouteRequest::setNumberAlternativeRoutes(int alternatives)
Устанавливает количество альтернативных маршрутов на запрос на alternatives. Если alternatives отрицательное, количество альтернативных маршрутов устанавливается в 0.
Значение по умолчанию — 0.
См. также numberAlternativeRoutes().
void QGeoRouteRequest::setRouteOptimization(QGeoRouteRequest::RouteOptimizations optimization)
Устанавливает критерии оптимизации при планировании маршрута на optimization.
Значение по умолчанию — QGeoRouteRequest::FastestRoute.
См. также routeOptimization().
void QGeoRouteRequest::setSegmentDetail(QGeoRouteRequest::SegmentDetail segmentDetail)
Устанавливает уровень детализации для представления маршрутных участков на segmentDetail.
См. также segmentDetail().
void QGeoRouteRequest::setTravelModes(QGeoRouteRequest::TravelModes travelModes)
Устанавливает типы передвижения, которые должны учитываться при планировании маршрута на travelModes.
Значение по умолчанию — QGeoRouteRequest::CarTravel.
См. также travelModes().
void QGeoRouteRequest::setWaypoints(const QList<QGeoCoordinate> &waypoints)
Устанавливает waypoints как точки маршрута, через которые должен пройти маршрут.
Точки маршрута должны быть указаны в порядке от начала до конца.
Этот запрос будет недействителен до тех пор, пока точки маршрута не будут установлены в список, содержащий две или более координаты.
См. также waypoints().
void QGeoRouteRequest::setWaypointsMetadata(const QList<QVariantMap> &waypointMetadata)
Устанавливает waypointMetadata в качестве метаданных для точек маршрута, заданных в этом запросе. Метаданные предназначены как одна QVariantMap на точку маршрута, заданные в том же порядке, что и точки маршрута.
Содержание QVariantMap каким-то образом специфично для бэкэнда, но свойства, которые можно указать с помощью элементов Waypoint в QML, можно предположить, что они названы и работают одинаково во всех плагинах, где это поддерживается.
См. также waypointsMetadata().
QGeoRouteRequest::TravelModes QGeoRouteRequest::travelModes() const
Возвращает типы передвижения, которые этот запрос указывает для планирования маршрута.
См. также setTravelModes().
QList<QGeoCoordinate> QGeoRouteRequest::waypoints() const
Возвращает точки маршрута, через которые будет проходить маршрут.
См. также setWaypoints().
QList<QVariantMap> QGeoRouteRequest::waypointsMetadata() const
Возвращает метаданные для точек маршрута в этом запросе.
См. также setWaypointsMetadata().
bool QGeoRouteRequest::operator!=(const QGeoRouteRequest &other) const
Возвращает значение, показывающее, равны ли этот запрос маршрута и other.
QGeoRouteRequest &QGeoRouteRequest::operator=(const QGeoRouteRequest &other)
Присваивает other этому объекту запроса маршрута и затем возвращает ссылку на этот объект запроса маршрута.
bool QGeoRouteRequest::operator==(const QGeoRouteRequest &other) const
Возвращает значение, показывающее, равны ли этот запрос маршрута и other.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.12/qgeorouterequest.html