ClosestFacilitySolverProperties (arcpy.na)
Zusammenfassung
Provides access to analysis properties from a closest facility network analysis layer. The GetSolverProperties function is used to obtain a ClosestFacilitySolverProperties object from a closest facility network analysis layer.
Diskussion
The ClosestFacilitySolverProperties object provides read and write access to all the analysis properties of a closest facility network analysis layer. The object can be used to modify the desired analysis properties of the closest facility layer, and the corresponding layer can be re-solved to determine the appropriate results. A new closest facility layer can be created using the Make Closest Facility Layer geoprocessing tool. Obtaining the ClosestFacilitySolverProperties object from a new closest facility layer allows you to reuse the existing layer for subsequent analyses rather than create a new layer for each analysis, which can be slow.
After modifying the properties on the ClosestFacilitySolverProperties object, the corresponding layer can be immediately used with other functions and geoprocessing tools. There is no refresh or update of the layer required to honor the changes modified through the object.
Eigenschaften
Eigenschaft | Erläuterung | Datentyp |
accumulators (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen einer Liste der Netzwerk-Kostenattribute, die als Teil der Analyse akkumuliert werden. Eine leere Liste, [], weist darauf hin, dass keine Kostenattribute akkumuliert werden. | String |
attributeParameters (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der parametrierten Attribute, die für die Analyse verwendet werden sollen. Die Eigenschaft gibt ein Python-Wörterbuch zurück. Der Wörterbuchschlüssel ist ein Tupel mit zwei Werten, der aus dem Attributnamen und dem Parameternamen besteht. Der Wert der einzelnen Elemente im Wörterbuch ist der Parameterwert. Mithilfe der parametrierten Netzwerkattribute können dynamische Aspekte eines Attributwertes modelliert werden. So kann beispielsweise ein Tunnel mit einer Höhenbeschränkung von 12 Fuß mit einem Parameter modelliert werden. In diesem Fall sollte die Höhe des Fahrzeugs (in Fuß) als angegebener Parameterwert verwendet werden. Wenn das Fahrzeug höher als 12 Fuß ist, wird diese Einschränkung als "Wahr" bewertet und das Passieren des Tunnels somit untersagt. Entsprechend kann eine Brücke einen Parameter zur Angabe einer Gewichtsbeschränkung aufweisen. Das Ändern der festgelegten Eigenschaft " attributeParameters" würde keine aktualisierten Werte zurückgeben. Sie sollten daher immer ein neues Wörterbuchobjekt verwenden, um die Werte für die Eigenschaft festzulegen. Die zwei folgenden Codeblöcke veranschaulichen den Unterschied zwischen diesen beiden Ansätzen:
| Dictionary |
defaultCutoff (Lesen und schreiben) | 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 (Lesen und schreiben) | Provides the ability to get or set the number of closest facilities to find per incident. | Integer |
impedance (Lesen und schreiben) | 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 (Lesen und schreiben) | 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:
| String |
restrictions (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen einer Liste der Restriktionsattribute, die für die Analyse angewendet werden. Eine leere Liste, [], weist darauf hin, dass keine Restriktionsattribute für die Analyse verwendet werden. | String |
solverName (Schreibgeschützt) | Returns the name of the solver being referenced by the 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 (Lesen und schreiben) | 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.
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 (Lesen und schreiben) | 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:
| String |
timeZoneUsage (Lesen und schreiben) | Specifies the time zone of the timeOfDay parameter.
Irrespective of the timeZoneUsage setting, if your facilities and incidents are in multiple time zones, the following rules are enforced by the tool:
| String |
travelDirection (Lesen und schreiben) | 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:
| String |
useHierarchy (Lesen und schreiben) | Steuert die Verwendung des Hierarchieattributs während der Durchführung der Analyse. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
uTurns (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der Richtlinie, die angibt, wie der Solver Wenden an Knoten, die beim Durchlaufen des Netzwerks zwischen Stopps auftreten können, verarbeitet. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
Codebeispiel
The script shows how to update a closest facility network analysis layer to find three facilities without using a cutoff value. It assumes that a closest facility layer called Closest Hospitals has been created in a new map document based on the tutorial network dataset for San Francisco region.
#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