VehicleRoutingProblemSolverProperties

Zusammenfassung

Provides access to analysis properties from a vehicle routing problem Network Analyst layer. The GetSolverProperties function is used to obtain a VehicleRoutingProblemSolverProperties object from a vehicle routing problem Network Analyst layer.

Beschreibung

The VehicleRoutingProblemSolverProperties object provides read and write access to all the analysis properties of a vehicle routing problem Network Analyst layer. The object can be used to modify the desired analysis properties of the vehicle routing problem layer, and the corresponding layer can be re-solved to determine the appropriate results. A new vehicle routing problem layer can be created using the Make Vehicle Routing Problem Layer geoprocessing tool. Obtaining the VehicleRoutingProblemSolverProperties object from a new vehicle routing problem 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 of the VehicleRoutingProblemSolverProperties 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
attributeParameters (Lesen und schreiben)	Provides the ability to get or set the parameterized attributes to be used in the analysis. The property returns a Python dictionary. The dictionary key is a two-value tuple consisting of the attribute name and the parameter name. The value for each item in the dictionary is the parameter value. Parameterized network attributes are used to model some dynamic aspect of an attribute's value. For example, a tunnel with a height restriction of 12 feet can be modeled using a parameter. In this case, the vehicle's height in feet should be specified as the parameter value. If the vehicle is taller than 12 feet, this restriction will then evaluate to True, thereby restricting travel through the tunnel. Similarly, a bridge could have a parameter to specify a weight restriction. Attempting to modify the attributeParameters property in place won't result in updated values. Instead, you should always use a new dictionary object to set values for the property. The following two code blocks demonstrate the difference between these two approaches. #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 If the network analysis layer does not have parameterized attributes, this property returns None.	Dictionary
capacityCount (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen der Anzahl an Abmessungen für die zulässige Höchstlast, mit denen die jeweiligen Höchstlasten der Fahrzeuge beschrieben werden.	Integer
defaultDate (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen des impliziten Datums für Zeitfeldwerte, für die kein Datum für die Uhrzeit angegeben wurde. Wenn ein Zeitfeld für ein Auftragsobjekt, z. B. "TimeWindowStart1", einen reinen Uhrzeitwert enthält, wird als Datum der Eigenschaftswert defaultDate verwendet. Wenn ein Auftrag beispielsweise den Wert "TimeWindowStart1" von 9:00 Uhr aufweist und defaultDate auf datetime.date(2012, 3, 6) gesetzt ist, wird als vollständiger Zeitwert für das Feld der Wert "9:00 Uhr, 6. März 2012" verwendet. Das Standarddatum wirkt sich nicht auf Feldwerte aus, die bereits ein Datum aufweisen. Mithilfe der folgenden Datumsangaben kann auch ein Wochentag als Standarddatum angegeben werden: Heute – 30.12.1899 Sonntag – 31.12.1899 Montag – 1.1.1900 Dienstag – 2.1.1900 Mittwoch – 3.1.1900 Donnerstag – 4.1.1900 Freitag – 5.1.1900 Samstag – 06.01.1900 Wenn Sie beispielsweise angeben möchten, dass das implizite Datum für Zeitfeldwerte "Dienstag" sein soll, müssen Sie den folgenden Eigenschaftswert angeben: 1/2/1900.	DateTime
distanceAttribute (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen des Entfernungskostenattributs, mit dem die Länge entlang der Netzwerkelemente definiert wird.	String
distanceFieldUnits (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen der Entfernungseinheiten, die von den Entfernungsfeldern in den Sublayern und Tabellen des Analyse-Layers verwendet werden (Netzwerkanalyseklassen). Die Einheit muss nicht mit der Einheit des Netzwerkkostenattributs übereinstimmen, das als Eigenschaftswert timeAttribute angegeben wird. Nachfolgend finden Sie eine Liste der möglichen Werte: Zentimeter Dezimeter Fuß Zoll Kilometer Meter Meilen Millimeter Seemeilen Yard	String
excessTransitTimeImportance (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen der Bedeutung für die Reduzierung von Fahrzeitüberschreitungen. Die Fahrzeitüberschreitung entspricht der Zeit, um die die direkte Fahrzeit zwischen den Auftragspaaren überschritten wird. Die Fahrzeitüberschreitung ergibt sich aus Unterbrechungen oder Fahrten zu anderen Aufträgen oder Depots, die zwischen den Auftragspaaren stattgefunden haben. Nachfolgend finden Sie eine Liste der möglichen Werte: Hoch —Der Solver versucht, eine Lösung zu finden, durch die Fahrzeitüberschreitungen bei Auftragspaaren auf Kosten steigender Gesamtfahrzeiten minimiert werden. Diese Einstellung empfiehlt sich, wenn bei Aufträgen Personen befördert werden und Sie die Fahrzeiten der Personen verkürzen möchten. Ein typisches Beispiel sind Taxiunternehmen. Mittel —Der Solver sucht einen Kompromiss zwischen der Reduzierung der Fahrzeitüberschreitung und der Senkung der Gesamtlösungskosten. Niedrig —Der Solver versucht, eine Lösung zu finden, durch die die Gesamtlösungskosten unabhängig von Zeitüberschreitungen minimiert werden. Diese Einstellung wird normalerweise von Kurierdiensten verwendet. Da Kurierdienste Pakete und keine Personen befördern, muss die Fahrzeit nicht berücksichtigt werden. Mit der Einstellung "Niedrig" können Kuriere Auftragspaare in der ordnungsgemäßen Reihenfolge abwickeln und die Gesamtlösungskosten minimieren.	String
outputPathShape (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen des Shape-Typs für die Routen-Features, die vom Solver ausgegeben werden. Nachfolgend finden Sie eine Liste der möglichen Werte: TRUE_LINES_WITH_MEASURES —Die Ausgaberouten weisen die exakte Form der zugrunde liegenden Netzwerkquellen auf. Die Ausgabe umfasst zudem Routenmesswerte für die lineare Referenzierung. Die Messwerte nehmen ab dem ersten Halt zu und zeichnen die kumulierte Impedanz zum Erreichen einer definierten Position auf. TRUE_LINES_WITHOUT_MEASURES —Die Ausgaberouten weisen die exakte Form der zugrunde liegenden Netzwerkquellen auf. STRAIGHT_LINES —Das Ausgaberouten-Shape weist pro Routensequenz gerade Linien zwischen den Aufträgen und Depotstopps auf. NO_LINES —Für die Ausgaberouten wird kein Shape erstellt. Es können außerdem auch keine Wegbeschreibungen generiert werden.	String
restrictions (Lesen und schreiben)	Provides the ability to get or set a list of restriction attributes that are applied for the analysis. An empty list, [], indicates that no restriction attributes are used for the analysis.	String
solverName (Nur lesen)	Gibt den Namen des Solvers zurück, der vom Network Analyst-Layer referenziert wird, um das Eigenschaftenobjekt des Solvers zu erhalten. Die Eigenschaft gibt immer den Zeichenfolgenwert Vehicle Routing Problem Solver zurück, wenn der Zugriff über ein VehicleRoutingProblemSolverProperties-Objekt erfolgt.	String
timeAttribute (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen des zeitbasierten Netzwerkkostenattributs, mit dem die Routenzeit entlang der Netzwerkelemente definiert wird. Dieses Kostenattribut wird vom Solver während der Ermittlung der Lösung minimiert.	String
timeFieldUnits (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen der Zeiteinheit, die von den Zeitdatenfeldern in den Sublayern und Tabellen des Analyse-Layers verwendet wird (Netzwerkanalyseklassen). Die Einheit muss nicht mit der Einheit des Netzwerkkostenattributs übereinstimmen, das als Eigenschaftswert timeAttribute angegeben wird. Nachfolgend finden Sie eine Liste der möglichen Werte: Tage Stunden Minuten Sekunden	String
timeWindowViolationImportance (Lesen und schreiben)	Ermöglicht das Abrufen oder Festlegen der Bedeutung für die Einhaltung von Zeitfenstern, ohne Zeitfensterverletzungen zu verursachen. Eine Zeitfensterverletzung tritt auf, wenn eine Route nach dem Schließen eines Zeitfensters einen Auftrag, ein Depot oder eine Unterbrechung erreicht. Als Verletzung ist das Intervall zwischen dem Ende des Zeitfensters und der Ankunftszeit einer Route definiert. Nachfolgend finden Sie eine Liste der möglichen Werte: Hoch —Der Solver versucht, eine Lösung zu finden, durch die Zeitfensterverletzungen auf Kosten steigender Gesamtfahrzeiten minimiert werden. Wählen Sie diese Option aus, wenn die rechtzeitige Ankunft bei Aufträgen wichtiger ist als eine Minimierung der Gesamtlösungskosten. Dies kann z. B. der Fall sein, wenn Sie einen Termin mit Kunden bei den Aufträgen vereinbart haben und eine verspätete Ankunft vermeiden möchten (eine weitere Möglichkeit ist die Verwendung von harten Zeitfenstern, bei denen keine Verletzung zulässig ist).Wenn weitere Beschränkungen eines Vehicle Routing Problem vorliegen, ist es eventuell unmöglich, alle Aufträge innerhalb ihrer Zeitfenster zu erreichen. In diesem Fall können selbst bei Auswahl dieser Option Zeitfensterverletzungen auftreten. Mittel —Der Solver sucht einen Kompromiss zwischen der Einhaltung von Zeitfenstern und der Senkung der Gesamtlösungskosten. Niedrig —Der Solver versucht, eine Lösung zu finden, durch die die Gesamtfahrzeit unabhängig von Zeitfenstern minimiert wird. Wählen Sie diese Option aus, wenn die Einhaltung von Zeitfenstern weniger wichtig ist als die Reduzierung der Gesamtlösungskosten. Sie können ggf. diese Einstellung wählen, wenn Sie einen wachsenden Rückstand an Service-Anforderungen bewältigen müssen. Um an einem Tag mehr Aufträge durchführen zu können und den Rückstand abzuarbeiten, können Sie diese Option auswählen, auch wenn den Kunden durch die Verspätungen Ihrer Fahrzeugflotte Unannehmlichkeiten entstehen.	String
useHierarchy (Lesen und schreiben)	Controls the use of the hierarchy attribute while performing the analysis. The following is a list of possible values: USE_HIERARCHY — Use the hierarchy attribute for the analysis. Using a hierarchy results in the solver preferring higher-order edges to lower-order edges. Hierarchical solves are faster, and they can be used to simulate the preference of a driver who chooses to travel on freeways over local roads when possible—even if that means a longer trip. This option is applicable only if the network dataset referenced by the Network Analyst layer has a hierarchy attribute. A value of True can also be used to specify this option. NO_HIERARCHY —Do not use the hierarchy attribute for the analysis. Not using a hierarchy yields an exact route for the network dataset. A value of False can also be used to specify this option.	String
uTurns (Lesen und schreiben)	Provides the ability to get or set the policy that indicates how the U-turns at junctions that could occur during network traversal between stops are being handled by the solver. The following is a list of possible values: ALLOW_UTURNS —U-turns are permitted at junctions with any number of connected edges. NO_UTURNS —U-turns are prohibited at all junctions, regardless of junction valency. Note, however, that U-turns are still permitted at network locations even when this setting is chosen; however, you can set the individual network locations' CurbApproach property to prohibit U-turns there as well. ALLOW_DEAD_ENDS_ONLY —U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end). ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY —U-turns are prohibited at junctions where exactly two adjacent edges meet but are permitted at intersections (junctions with three or more adjacent edges) and dead ends (junctions with exactly one adjacent edge). Often, networks have extraneous junctions in the middle of road segments. This option prevents vehicles from making U-turns at these locations.	String

Methodenübersicht

Methode	Erläuterung
applyTravelMode (travel_mode)	Updates the analysis properties of a network analyst layer based on a travel mode object. The updated network analyst layer can then be solved to complete the analysis.

Methoden

applyTravelMode (travel_mode)

Parameter	Erläuterung	Datentyp
travel_mode	A variable that references a travel mode object derived from a network dataset. A list of travel mode objects can be obtained by calling the arcpy.na.GetTravelModes function.	Object

When a network analyst layer is created, it is assigned default values for all of its analysis properties. The individual analysis properties can be updated using a solver properties object obtained from the network analyst layer. A travel mode stores a predefined set of analysis settings that help to perform a particular analysis, such as a walking time travel mode that stores the analysis settings required to perform a time-based walking analysis.

Using the applyTravelMode method, all the analysis settings that are defined in a travel mode can be applied at once. After the analysis properties are updated, the network analyst layer can be solved to complete the analysis.

If there is an error when updating the solver properties, such as when the provided travel mode references properties that don't exist on the current network dataset or references properties that are no longer applicable to the network dataset that was used to create the network analyst layer corresponding to the solver properties object, no exceptions are raised. The method will execute successfully, but you will get errors when you try to solve such a network analyst layer.

If the travel_mode parameter does not reference a travel mode object or a string, a TypeError exception is raised. If the travel_mode parameter references a string and the string cannot be internally converted to a valid string representation of a travel mode object, a ValueError exception is raised.

Codebeispiel

VehicleRoutingProblemSolverProperties example 1

The script shows how to update the Distance Attribute, Default Date, U-Turns at Junctions, and Output Shape Type properties for an existing vehicle routing problem layer in the ArcMap table of contents. It assumes that a vehicle routing problem layer called Store Delivery Routes has been created in a new map document based on the tutorial network dataset of the San Francisco region.

#Get the vehicle routing problem layer object from a layer named
#"Store Delivery Routes" in the table of contents
vrpLayer = arcpy.mapping.Layer("Store Delivery Routes")

#Get the solver properties object from the vehicle routing problem layer
solverProps = arcpy.na.GetSolverProperties(vrpLayer)

#Update the properties for the vehicle routing problem layer using the 
#solver properties object
solverProps.distanceAttribute = "Meters"
#Set the default date to be Monday
solverProps.defaultDate = datetime.date(1900,1,1)
solverProps.uTurns = "NO_UTURNS"
solverProps.outputPathShape = "STRAIGHT_LINES"

ApplyTravelMode example 2 (workflow)

This script shows how to find routes for a fleet of trucks using the Trucking Time travel mode.

#Import modules
import os
import arcpy

#Define variables
workspace = "C:/data/SanDiego.gdb"
output_folder = "C:/data/output"
nds = os.path.join(workspace, "Transportation", "Streets_ND")
orders = os.path.join(workspace, "Orders")
depots = os.path.join(workspace, "TruckDepots")
routes = os.path.join(workspace, "Drivers")
analysis_layer_name = "TruckRoutes"

#Set environment variables
arcpy.env.overwriteOutput = True

#Check out the network analyst extension
arcpy.CheckOutExtension("network")

#Create a new closest facility analysis layer
make_layer_result = arcpy.na.MakeVehicleRoutingProblemLayer(nds, analysis_layer_name,
                                                            "TravelTime")
analysis_layer = make_layer_result.getOutput(0)

#Add orders, depots and routes to the analysis layer using default field mappings         
sub_layer_names = arcpy.na.GetNAClassNames(analysis_layer)
order_layer_name = sub_layer_names["Orders"]
depot_layer_name = sub_layer_names["Depots"]
route_layer_name = sub_layer_names["Routes"]
arcpy.na.AddLocations(analysis_layer, order_layer_name, orders, "#", "#")
arcpy.na.AddLocations(analysis_layer, depot_layer_name, depots, "#", "#")
arcpy.na.AddLocations(analysis_layer, route_layer_name, routes, "#", "#")

#Get the Trucking Time travel mode from the network dataset
travel_modes = arcpy.na.GetTravelModes(nds)
trucking_mode = travel_modes["Trucking Time"]

#Apply the travel mode to the analysis layer
solver_properties = arcpy.na.GetSolverProperties(analysis_layer)
solver_properties.applyTravelMode(trucking_mode)

#Solve the analysis layer skipping any invalid orders and save the result as a layer file          
arcpy.na.Solve(analysis_layer, "SKIP")

output_layer = os.path.join(output_folder, analysis_layer_name + ".lyr")
arcpy.management.SaveToLayerFile(analysis_layer, output_layer, "RELATIVE")

arcpy.AddMessage("Completed")