RouteQuery QML Type

Le type `RouteQuery` sert à fournir des paramètres de requête à une ` RouteModel`. En savoir plus...

• Liste de tous les membres, y compris les membres hérités

Propriétés

• departureTime : date
• excludedAreas : list<geoRectangle>
• featureTypes : QList<FeatureType>
• maneuverDetail : enumeration
• numberAlternativeRoutes : int
• routeOptimizations : enumeration
• segmentDetail : enumeration
• travelModes : enumeration
• waypoints : list<coordinate>

Méthodes

• void addExcludedArea(geoRectangle area)
• void addWaypoint(coordinate)
• void clearExcludedAreas()
• void clearWaypoints()
• FeatureWeight featureWeight(FeatureType featureType)
• void removeExcludedArea(geoRectangle area)
• void removeWaypoint(coordinate)
• void resetFeatureWeights()
• void setFeatureWeight(FeatureType feature, FeatureWeight weight)

Description détaillée

Un objet RouteQuery sert à regrouper tous les paramètres nécessaires pour envoyer une requête à un service de routage, qui peut ensuite remplir le contenu d'un objet RouteModel.

Ces paramètres décrivent les détails clés de l’itinéraire, tels que les points de passage ( waypoints ) à emprunter, les points à éviter ( excludedAreas ), le type de véhicule utilisé ( travelModes ), ainsi que les préférences détaillées concernant l’optimisation de l’itinéraire et les caractéristiques à privilégier ou à éviter le long du parcours (telles que les routes à péage, les autoroutes, etc.).

Les objets `RouteQuery` sont utilisés exclusivement pour renseigner la valeur de la propriété ` query ` d’une ` RouteModel`, ce qui permet ensuite de lancer le processus de récupération des données pour alimenter le modèle.

Certains plugins peuvent autoriser ou exiger des paramètres spécifiques pour fonctionner. Afin de spécifier ces paramètres propres au plugin, des éléments `MapParameter` peuvent être imbriqués à l’intérieur d’un `RouteQuery`.

Exemple d’utilisation

L'extrait de code suivant présente un exemple incomplet de création d’un objet RouteQuery et de son affectation à la propriété query d’un objet RouteModel.

RouteQuery {
    id: aQuery
}

RouteModel {
    query: aQuery
    autoUpdate: false
}

Pour un exemple plus complet, consultez la documentation relative au type ` RouteModel ` et l’exemple `Mapviewer`.

Voir également RouteModel.

Documentation sur les propriétés

departureTime : date

Heure de départ à utiliser lors de la recherche d'un itinéraire. La valeur par défaut correspond à une date non valide, ce qui signifie qu'aucune heure de départ ne sera utilisée dans la requête.

excludedAreas : list<geoRectangle>

Zones que l'itinéraire ne doit pas traverser.

Les zones exclues peuvent être définies dans la déclaration de type « RouteQuery » ou de manière dynamique à l’aide des fonctions fournies.

Voir également addExcludedArea, removeExcludedArea et clearExcludedAreas.

featureTypes : QList<FeatureType> [read-only]

Liste des éléments qui seront pris en compte lors de la planification de l'itinéraire. Les éléments dont la pondération est égale à NeutralFeatureWeight ne seront pas pris en compte.

• RouteQuery.NoFeature - Aucun élément ne sera pris en compte lors du calcul de l'itinéraire
• RouteQuery.TollFeature - Prise en compte des routes à péage lors du calcul de l'itinéraire
• RouteQuery.HighwayFeature - Prendre en compte les autoroutes lors de la planification de l'itinéraire
• RouteQuery.PublicTransitFeature - Prendre en compte les transports en commun lors de la planification de l'itinéraire
• RouteQuery.FerryFeature - Prendre en compte les ferries lors de la planification de l'itinéraire
• RouteQuery.TunnelFeature - Prendre en compte les tunnels lors de la planification de l'itinéraire
• RouteQuery.DirtRoadFeature - Prendre en compte les chemins de terre lors de la planification de l'itinéraire
• RouteQuery.ParksFeature - Prendre en compte les parcs lors de la planification de l'itinéraire
• RouteQuery.MotorPoolLaneFeature - Prendre en compte les voies réservées aux flottes de véhicules lors de la planification de l'itinéraire
• RouteQuery.TrafficFeature - Prendre en compte le trafic lors de la planification de l'itinéraire

Voir également setFeatureWeight et featureWeight.

maneuverDetail : enumeration

Le niveau de détail qui sera utilisé pour la représentation des manœuvres de routage.

La valeur par défaut est « RouteQuery.BasicManeuvers ».

numberAlternativeRoutes : int

Nombre d'itinéraires alternatifs à proposer lors de la recherche d'itinéraires. La valeur par défaut est 0.

routeOptimizations : enumeration

Les optimisations d'itinéraire à prendre en compte lors de la planification de l'itinéraire. Les valeurs peuvent être combinées à l'aide de l'opérateur OR (« | »).

La valeur par défaut est RouteQuery.FastestRoute.

segmentDetail : enumeration

Le niveau de détail qui sera utilisé pour la représentation des segments de routage.

La valeur par défaut est « RouteQuery.BasicSegmentData ».

travelModes : enumeration

Les modes de transport à prendre en compte lors de la planification de l'itinéraire. Les valeurs peuvent être combinées à l'aide de l'opérateur OR (« | »).

La valeur par défaut est « RouteQuery.CarTravel ».

waypoints : list<coordinate>

Les coordonnées des points de passage de l'itinéraire souhaité. Les points de passage doivent être indiqués dans l'ordre, du point de départ à la destination. Il faut au moins deux coordonnées.

Les points de passage peuvent être définis dans la déclaration de type RouteQuery ou de manière dynamique à l'aide des fonctions fournies.

Voir également addWaypoint, removeWaypoint et clearWaypoints.

Documentation des méthodes

void addExcludedArea(geoRectangle area)

Ajoute la zone spécifiée geoRectangle area à la liste des zones exclues (zones que l'itinéraire ne doit pas traverser). Une même zone ne peut être ajoutée qu'une seule fois.

Voir également removeExcludedArea et clearExcludedAreas.

void addWaypoint(coordinate)

Ajoute les coordonnées coordinate indiquées à la liste des points de passage. Une même coordonnée peut être définie plusieurs fois.

Voir également « removeWaypoint » et « clearWaypoints ».

void clearExcludedAreas()

Efface toutes les zones exclues (zones que l'itinéraire ne doit pas traverser).

Voir également addExcludedArea et removeExcludedArea.

void clearWaypoints()

Efface tous les points de passage.

Voir également removeWaypoint et addWaypoint.

FeatureWeight featureWeight(FeatureType featureType)

Récupère le poids associé à l'featureType.

Voir également featureTypes, setFeatureWeight et resetFeatureWeights.

void removeExcludedArea(geoRectangle area)

Supprime l'area on indiquée des zones exclues (zones que l'itinéraire ne doit pas traverser).

Voir aussi « addExcludedArea » et « clearExcludedAreas ».

void removeWaypoint(coordinate)

Supprime les coordonnées coordinate indiquées de la liste des points de passage. Si les mêmes s apparaissent plusieurs fois, c'est l'instance ajoutée le plus récemment qui est supprimée.

Voir également « addWaypoint » et « clearWaypoints ».

void resetFeatureWeights()

Réinitialise toutes les pondérations des caractéristiques à leur valeur par défaut (NeutralFeatureWeight).

Voir également featureTypes, setFeatureWeight et featureWeight.

void setFeatureWeight(FeatureType feature, FeatureWeight weight)

Définit l'weight s à associer à un « feature » lors de la planification d'un itinéraire.

La liste suivante répertorie les pondérations possibles des éléments :

Voir également featureTypes, resetFeatureWeights et featureWeight.