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. #Don't attempt to modify the attributeParameters property in place. #This coding method won't work. solverProps.attributeParameters[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED" #Modify the attributeParameters property using a new dictionary object. #This coding method works. params = solverProps.attributeParameters params[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED" solverProps.attributeParameters = params Si la couche d'analyse de réseau ne comporte pas d'attributs paramétrés, cette propriété retourne la valeur Aucun.	Dictionary
findBestSequence (Lecture/écriture)	Controls whether the stops are reordered to find optimal routes. The following is a list of possible values: FIND_BEST_ORDER —The stops will be reordered to find the optimal route. This option changes the route analysis from a shortest-path problem to a traveling salesperson problem (TSP). A value of True can also be used to specify this option. USE_INPUT_ORDER —The stops will be visited in the input order. A value of False can also be used to specify this option.	String
impedance (Lecture/écriture)	Provides the ability to get or set the network cost attribute used as impedance. This cost attribute is minimized while determining the best route.	String
orderingType (Lecture/écriture)	Controls the ordering of stops when findBestSequence property is set to FIND_BEST_ORDER. The following is a list of possible values: PRESERVE_BOTH —Preserves the first and last stops by input order as the first and last stops in the route. PRESERVE_FIRST —Preserves the first stop by input order as the first stop in the route, but the last stop is free to be reordered. PRESERVE_LAST —Preserves the last stop by input order as the last stop in the route, but the first stop is free to be reordered. PRESERVE_NONE —Frees both the first and last stop to be reordered.	String
outputPathShape (Lecture/écriture)	Provides the ability to get or set the shape type for the route features that are output by the solver. The following is a list of possible values: TRUE_LINES_WITH_MEASURES —The output routes will have the exact shape of the underlying network sources. Furthermore, the output includes route measurements for linear referencing. The measurements increase from the first stop and record the cumulative impedance to reach a given position. TRUE_LINES_WITHOUT_MEASURES —The output routes will have the exact shape of the underlying network sources. STRAIGHT_LINES —The output route shape will be a single straight line between the stops. NO_LINES —No shape will be generated for the output routes.	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)	Returns the name of the solver being referenced by the network analysis layer used to obtain the solver properties object. The property always returns the string value Route Solver when accessed from a RouteSolverProperties object.	String
timeOfDay (Lecture/écriture)	Provides the ability to get or set the start date and time for the route. Route start time is mostly used to find routes based on the impedance attribute that varies with the time of the day. For example, a start time of 9 a.m. could be used to find a route that considers the rush-hour traffic. A value of None can be used to specify that no date and time should be used. Instead of using a particular date, a day of the week can be specified using the following dates: Aujourd'hui - 12/30/1899 Dimanche - 12/31/1899 Lundi - 1/1/1900 Mardi - 1/2/1900 Mercredi - 1/3/1900 Jeudi - 1/4/1900 Vendredi - 1/5/1900 Samedi - 1/6/1900 For example, to specify that the route should start at 5:00 p.m. on Tuesday, specify the value as datetime.datetime(1900, 1, 2, 17,0,0). The timeZoneUsage parameter specifies whether the date and time refer to UTC or the time zone in which the first stop is located.	DateTime
timeZoneUsage (Lecture/écriture)	Specifies the time zone of the timeOfDay parameter. GEO_LOCAL —The timeOfDay parameter refers to the time zone in which the first stop is located. UTC —The timeOfDay parameter refers to Coordinated Universal Time (UTC). Choose this option if you want to solve the analysis for a specific time, such as now, but aren't certain in which time zone the facilities or demand points will be located. When solving a route analysis that spans across multiple time zones and setting a start time, the orderingType cannot be set to PRESERVE_NONE. A starting location and time zone must be fixed.	String
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 : ALLOW_UTURNS —Les demi-tours sont autorisés aux jonctions comportant un nombre quelconque de tronçons connectés. NO_UTURNS —Les demi-tours sont interdits à toutes les jonctions, indépendamment de la valence de jonction. Notez toutefois que les demi-tours restent autorisés aux emplacements réseau même lorsque ce paramètre est sélectionné ; en revanche, vous pouvez configurer la propriété CurbApproach des emplacements réseau individuels pour y interdire les demi-tours également. ALLOW_DEAD_ENDS_ONLY —Les demi-tours sont interdits au niveau de toutes les jonctions, sauf celles ayant un seul tronçon adjacent (voie sans issue). ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY —Les demi-tours sont interdits aux jonctions où deux tronçons adjacents se rencontrent, mais sont autorisés aux intersections (jonctions avec au moins trois tronçons adjacents) et aux voies sans issue (jonctions avec exactement un tronçon adjacent). Souvent, les réseaux comportent des jonctions superflues au milieu de segments de route. Cette option empêche des véhicules de faire des demi-tours à ces emplacements.	String
useHierarchy (Lecture/écriture)	Contrôle l'utilisation de l'attribut de hiérarchie lors de l'analyse. Voici une liste des valeurs possibles : USE_HIERARCHY — Utilise l'attribut de hiérarchie pour l'analyse. L'utilisation d'une hiérarchie implique une préférence du solveur pour les tronçons d'ordre supérieur par rapport aux tronçons d'ordre inférieur. Les recherches hiérarchiques sont plus rapides et permettent de simuler la préférence d'un chauffeur de circuler sur des autoroutes au lieu de routes locales si possible, même si cela implique un trajet plus long. Cette option s'applique uniquement si le jeu de données réseau référencé par la couche ArcGIS Network Analyst dispose d'un attribut de hiérarchie. Une valeur True peut également être utilisée pour spécifier cette option. NO_HIERARCHY —N'utilise pas l'attribut de hiérarchie pour l'analyse. Un itinéraire exact est alors obtenu pour le jeu de données réseau. Une valeur False peut également être utilisée pour spécifier cette option.	String
useTimeWindows (Lecture/écriture)	Controls if time windows will be used at the stops. The following is a list of possible values: USE_TIMEWINDOWS —The route will consider time windows on the stops. If a stop is arrived at before its time window, there will be wait time until the time window starts. If a stop is arrived at after its time window, there will be a time-window violation. Total time-window violation is balanced against minimum impedance when computing the route. This option is applicable only when the network cost attribute specified as the value for impedance property is in time units. A value of True can also be used to specify this option. NO_TIMEWINDOWS —The route will ignore time windows on the stops. A value of False can also be used to specify this option.	String

Exemple de code

Exemple 1 d'utilisation de l'objet RouteSolverProperties (fenêtre Python)

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()

Exemple 2 d'utilisation de l'objet RouteSolverProperties (workflow)

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")