ClosestFacilitySolverProperties (arcpy.na)

Récapitulatif

Permet d'accéder aux propriétés d'analyse à partir d'une couche d'analyse de réseau de ressource la plus proche. La fonction GetSolverProperties permet d'obtenir un objet ClosestFacilitySolverProperties à partir d'une couche d'analyse de réseau de ressource la plus proche.

Discussion

L'objet ClosestFacilitySolverProperties permet un accès en lecture et en écriture à toutes les propriétés d'analyse d'une couche d'analyse de réseau de ressource la plus proche. L'objet permet de modifier les propriétés d'analyse souhaitées de la couche de ressource la plus proche, 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 de ressource la plus proche à l'aide de l'outil de géotraitement Générer une couche des ressources les plus proches. Obtenir l'objet ClosestFacilitySolverProperties à partir d'une nouvelle couche de ressource la plus proche 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 ClosestFacilitySolverProperties 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
defaultCutoff (Lecture/écriture)	Provides the ability to get or set the default impedance value at which the solver will stop searching for facilities for a given incident. A value of None is used to specify that no cutoff should be used.	Double
defaultTargetFacilityCount (Lecture/écriture)	Provides the ability to get or set the number of closest facilities to find per incident.	Integer
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 closest facility and the best route to the closest facility.	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 each of the incident-facility pair. 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 ArcGIS Network Analyst layer used to obtain the solver properties object. The property always returns the string value Closest Facility Solver when accessed from a ClosestFacilitySolverProperties object.	String
timeOfDay (Lecture/écriture)	Provides the ability to get or set the time and date at which the routes should begin or end. The interpretation of this value depends on whether timeOfDayUsage property is set to START_TIME or END_TIME. 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 or end at 8:00 a.m. on Monday, specify the value as datetime.datetime(1900, 1, 1, 8,0,0). The timeZoneUsage parameter specifies whether the date and time refer to UTC or the time zone in which the facilities or incidents are located.	DateTime
timeOfDayUsage (Lecture/écriture)	Controls whether the value of the timeOfDay property represents the arrival or departure times for the routes. The following is a list of possible values: END_TIME —The routes arrive at the facilities or incidents at the time you set in the timeOfDay property. This choice is useful if arrival time is more important; that is, you want to know what time you need to leave in order to arrive at your destination at a given time. START_TIME —The routes depart from the facilities or incidents at the time you set in the timeOfDay property. This choice is useful to find the best routes given a departure time. NOT_USED —The routes do not use a start or end time and date. This choice should be used if the timeOfDay property has a value of None.	String
timeZoneUsage (Lecture/écriture)	Specifies the time zone of the timeOfDay parameter. GEO_LOCAL —The timeOfDay parameter refers to the time zone in which the facilities or incidents are located. If timeOfDayUsage is set to Start_Time and travelDirection is TRAVEL_FROM, this is the time zone of the facilities. If timeOfDayUsage is set to Start_Time and travelDirection is TRAVEL_TO, this is the time zone of the incidents. If timeOfDayUsage is set to End_Time and travelDirection is TRAVEL_FROM, this is the time zone of the incidents. If timeOfDayUsage is set to End_Time and travelDirection is TRAVEL_TO, this is the time zone of the facilities. UTC —The timeOfDay parameter refers to Coordinated Universal Time (UTC). Choose this option if you want to find what's nearest for a specific time, such as now, but aren't certain in which time zone the facilities or incidents will be located. Irrespective of the timeZoneUsage setting, if your facilities and incidents are in multiple time zones, the following rules are enforced by the tool: All incidents must be in the same time zone when Specifying a start time and traveling from incident to facility Specifying an end time and traveling from facility to incident All facilities must be in the same time zone when Specifying a start time and traveling from facility to incident Specifying an end time and traveling from incident to facility	String
travelDirection (Lecture/écriture)	Provides the ability to get or set the direction of travel between facilities and incidents during the analysis. The following is a list of possible values: TRAVEL_FROM —Direction of travel is from facilities to incidents. TRAVEL_TO —Direction of travel is from incidents to facilities.	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
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

Exemple de code

Exemple d'utilisation de l'objet ClosestFacilitySolverProperties (Fenêtre Python)

Le script indique comment mettre à jour une couche d'analyse de réseau de ressource la plus proche pour trouver trois ressources sans utiliser une valeur limite. Il suppose qu'une couche de ressource la plus proche appelée Hôpitaux les plus Proches a été créée 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 closest facility layer object from a layer named "Closest Hospitals" in
#the table of contents
cfLayer = arcpy.mapping.Layer("Closest Hospitals")

#Get the closest facility solver properties object from the closest facility layer
solverProps = arcpy.na.GetSolverProperties(cfLayer)

#Update the properties for the closest facility layer using the closest facility
#solver properties object
solverProps.defaultCutoff = None
solverProps.defaultTargetFacilityCount = 3