RouteSolverProperties (arcpy.na)
Récapitulatif
Permet d'accéder aux propriétés d'analyse d'une couche d'analyse de réseau d'itinéraire. La fonction GetSolverProperties permet d'obtenir un objet RouteSolverProperties à partir d'une couche d'analyse de réseau d'itinéraire.
Discussion
L'objet RouteSolverProperties permet un accès en lecture et en écriture à toutes les propriétés d'analyse d'une couche d'analyse de réseau d'itinéraire. L'objet permet de modifier les propriétés d'analyse souhaitées de la couche d'itinéraire, et la couche correspondante peut être analysée à nouveau en vue de déterminer les résultats appropriés. Il est possible de créer une nouvelle couche d'itinéraire à l'aide de l'outil de géotraitement Générer une couche d'itinéraires. Obtenir l'objet RouteSolverProperties à partir d'une nouvelle couche d'itinéraire permet de réutiliser la couche existante pour les analyses suivantes plutôt que de créer une couche pour chaque analyse, ce qui peut être un processus lent.
Une fois les propriétés de l'objet RouteSolverProperties modifiées, la couche correspondante peut être utilisée immédiatement avec d'autres fonctions et outils de géotraitement. Aucune actualisation ni mise à jour de la couche n'est requise pour respecter les changements effectués par l'intermédiaire de l'objet.
Propriétés
Propriété | Explication | Type de données |
accumulators (Lecture/écriture) | Permet d'obtenir ou de définir une liste des attributs de coût du réseau cumulés dans le cadre de l'analyse. Une liste vide, [], indique qu'aucun attribut de coût n'est cumulé. | String |
attributeParameters (Lecture/écriture) | Permet d'obtenir ou de définir les attributs paramétrés à utiliser dans l'analyse. La propriété retourne un dictionnaire Python. La clé de dictionnaire est un tuple à deux valeurs comprenant le nom de l'attribut et le nom du paramètre. La valeur de chaque élément du dictionnaire correspond à la valeur du paramètre. Les attributs de réseau paramétrés permettent de modéliser un aspect dynamique de la valeur d'un attribut. Par exemple, un tunnel avec une restriction de hauteur de 12 pieds peut être modélisé à l'aide d'un paramètre. Dans ce cas, la hauteur du véhicule en pieds doit être spécifiée en tant que valeur de paramètre. Si la hauteur du véhicule est supérieure à 12 pieds, cette restriction prend la valeur True, ce qui restreint le passage par le tunnel. De la même façon, un pont peut comporter un paramètre pour spécifier une restriction de poids. Toute tentative de modification de la propriété attributeParameters en place ne permet pas de mettre à jour les valeurs. Vous devez à la place toujours utiliser un nouvel objet dictionnaire pour définir des valeurs pour la propriété. Les deux blocs de code suivants montrent la différence entre ces deux approches.
| Dictionary |
findBestSequence (Lecture/écriture) | Contrôle si les arrêts sont réorganisés pour trouver des itinéraires optimaux. Voici une liste des valeurs possibles :
| String |
impedance (Lecture/écriture) | Permet d'obtenir ou de définir l'attribut de coût du réseau utilisé en tant qu'impédance. Cet attribut de coût est réduit en déterminant le meilleur itinéraire. | String |
orderingType (Lecture/écriture) | Contrôle le classement des arrêts lorsque la propriété findBestSequence est définie sur FIND_BEST_ORDER. Voici une liste des valeurs possibles :
| String |
outputPathShape (Lecture/écriture) | Permet d'obtenir ou de définir le type de forme pour les entités d'itinéraires générées en sortie par le solveur. Voici une liste des valeurs possibles :
| String |
restrictions (Lecture/écriture) | Permet d'obtenir ou de définir une liste des attributs de restriction appliqués pour l'analyse. Une liste vide, [], indique qu'aucun attribut de restriction n'est utilisé pour l'analyse. | String |
solverName (Lecture seule) |
Renvoie le nom du solveur qui est référencé par la couche d'analyse réseau utilisée pour obtenir l'objet des propriétés du solveur. La propriété renvoie toujours la valeur de chaîne Solveur d'itinéraire en cas d'accès depuis un objet RouteSolverProperties. | String |
timeOfDay (Lecture/écriture) | Permet d'obtenir ou de définir la date et l'heure de début pour l'itinéraire. L'heure de début de l'itinéraire permet principalement de trouver des itinéraires selon l'attribut d'impédance qui varie avec l'heure du jour. Par exemple, une heure de début égale à 9h permet de trouver un itinéraire tenant compte de la circulation à l'heure de pointe. Une valeur Aucun peut permettre de spécifier qu'aucune date et heure ne doivent être utilisées. Au lieu d'utiliser une date particulière, un jour de la semaine peut être spécifié à l'aide des dates suivantes :
Par exemple, pour préciser que l'itinéraire doit démarrer à 17h00 mardi, spécifiez la valeur sous la forme datetime.datetime(1900, 1, 2, 17,0,0). | DateTime |
uTurns (Lecture/écriture) | Permet d'obtenir ou de définir la stratégie qui indique comment les demi-tours aux jonctions qui pourraient survenir pendant la traversée du réseau entre différents arrêts sont gérés par le solveur. Voici une liste des valeurs possibles :
| String |
useHierarchy (Lecture/écriture) | Contrôle l'utilisation de l'attribut de hiérarchie lors de l'analyse. Voici une liste des valeurs possibles :
| String |
useTimeWindows (Lecture/écriture) | Contrôle si des fenêtres horaires sont utilisées au niveau des arrêts. Voici une liste des valeurs possibles :
| String |
Exemple de code
Le script indique comment mettre à jour la propriété d'impédance à l'attribut de coût TravelTime, spécifie des attributs de coût en minutes et en mètres comme attributs cumulatifs et utilise l'heure réelle comme heure de début d'itinéraire. Il suppose qu'une couche d'analyse de réseau d'itinéraire appelée Itinéraire a été créé dans un nouveau document ArcMap d'après le jeu de données réseau du didacticiel pour la région de San Francisco.
#Get the route layer object from a layer named "Route" in the table of contents
routeLayer = arcpy.mapping.Layer("Route")
#Get the route solver properties object from the route layer
solverProps = arcpy.na.GetSolverProperties(routeLayer)
#Update the properties for the route layer using the route solver properties object
solverProps.impedance = "TravelTime"
solverProps.accumulators = ["Meters", "Minutes"]
#Only set the time component from the current date time as time of day
solverProps.timeOfDay = datetime.datetime.now().time()
Le script illustre comment trouver l'itinéraire le plus court (distance) et le plus rapide (durée de trajet) entre un ensemble d'arrêts et enregistre chaque itinéraire en tant que classe d'entités dans une géodatabase. Il illustre la création d'une seule instance d'une couche d'itinéraire et la modification de la propriété d'impédance à l'aide de l'objet RouteSolverProperties afin d'obtenir les résultats souhaités.
import arcpy
#Set up the environment
arcpy.env.overwriteOutput = True
arcpy.CheckOutExtension("network")
#Set up variables
networkDataset = "C:/Data/SanFrancisco.gdb/Transportation/Streets_ND"
stops = "C:/Data/SanFrancisco.gdb/Analysis/Stores"
fastestRoute = "C:/Data/SanFrancisco.gdb/FastestRoute"
shortestRoute = "C:/Data/SanFrancisco.gdb/ShortestRoute"
#Make a new route layer using travel time as impedance to determine fastest route
routeLayer = arcpy.na.MakeRouteLayer(networkDataset, "StoresRoute",
"TravelTime").getOutput(0)
#Get the network analysis class names from the route layer
naClasses = arcpy.na.GetNAClassNames(routeLayer)
#Get the routes sublayer from the route layer
routesSublayer = arcpy.mapping.ListLayers(routeLayer, naClasses["Routes"])[0]
#Load stops
arcpy.na.AddLocations(routeLayer, naClasses["Stops"], stops)
#Solve the route layer
arcpy.na.Solve(routeLayer)
#Copy the route as a feature class
arcpy.management.CopyFeatures(routesSublayer, fastestRoute)
#Get the RouteSolverProperties object from the route layer to modify the
#impedance property of the route layer.
solverProps = arcpy.na.GetSolverProperties(routeLayer)
#Set the impedance property to "Meters" to determine the shortest route.
solverProps.impedance = "Meters"
#Resolve the route layer
arcpy.na.Solve(routeLayer)
#Copy the route as a feature class
arcpy.management.CopyFeatures(routesSublayer, shortestRoute)
arcpy.AddMessage("Completed")