GetToolInfo

Zusammenfassung

Rufen Sie Informationen wie die Beschreibung des Netzwerk-Datasets, das für die Analyse verwendet wird, und die Ausführungsbeschränkungen für ein Werkzeug des Geoverarbeitungsservice ab.

Verwendung

• Dieses Werkzeug soll vor der Ausführung anderer Werkzeuge im Geoverarbeitungsservice verwendet werden. Wenn Sie beispielsweise die maximale Anzahl der vom Werkzeug FindRoutes unterstützten Stopps ermitteln möchten, können Sie GetToolInfo ausführen, um den Grenzwert zu bestimmen.

Syntax

arcpy.naagol.GetToolInfo(serviceName, toolName)

Parameter	Erklärung	Datentyp
serviceName	Der Service-Name, der das Werkzeug enthält. Der Parameterwert sollte mit einem der folgenden Schlüsselwörter festgelegt werden, die einen bestimmten Geoverarbeitungsservice referenzieren: asyncClosestFacility: Der asynchrone Geoverarbeitungsservice zum Durchführen der Analyse der nächstgelegenen Einrichtung. asyncLocationAllocation: Der asynchrone Geoverarbeitungsservice zum Durchführen der Location-Allocation-Analyse. asyncRoute: Der asynchrone Geoverarbeitungsservice zum Durchführen der Routenanalyse. asyncServiceArea: Der asynchrone Geoverarbeitungsservice zum Durchführen der Einzugsgebietsanalyse. asyncVRP: Der asynchrone Geoverarbeitungsservice zum Durchführen der Vehicle Routing Problem-Analyse. syncVRP: Der synchrone Geoverarbeitungsservice zum Durchführen der Vehicle Routing Problem-Analyse. asyncODCostMatrix: Der asynchrone Geoverarbeitungsservice zum Durchführen der Start-Ziel-Kostenmatrix-Analyse. Der Standardwert ist asyncRoute.	String
toolName	Der Werkzeugname im Geoverarbeitungsservice. Der Parameterwert sollte ein gültiger Werkzeugname im Geoverarbeitungsservice sein, der durch den Parameter serviceName angegeben wird. Die folgenden Werkzeugnamen sind gültig: FindClosestFacilities für den Service asyncClosestFacility SolveLocationAllocation für den Service asyncLocationAllocation FindRoutes für den Service Route GenerateServiceAreas für den Service asyncServiceArea SolveVehicleRoutingProblem für den Service asyncVRP EditVehicleRoutingProblem für den Service syncVRP GenerateOriginDestinationCostMatrix für den Service asyncODCostMatrix Der Standardwert ist FindRoutes.	String

Abgeleitete Ausgabe

Name	Erklärung	Datentyp
toolInfo	Zusätzliche Informationen zu einem Werkzeug im Geoverarbeitungsservice.	Zeichenfolge

Codebeispiel

Beispiel für GetToolInfo

Das folgende Python-Skript veranschaulicht, wie das Werkzeug GetToolInfo in einem Skript verwendet wird.

'''
The script shows how to use the GetToolInfo tool to get the maximum number of stops
that can be used as inputs with FindRoutes tool.
'''
import sys
import json

import arcpy

#Change the username and password applicable to your own ArcGIS Online account
username = "<your user name>"
password = "<your password>"

utility_service = "https://logistics.arcgis.com/arcgis/services;World/Utilities;{0};{1}".format(username, password)

#Add the geoprocessing service as a toolbox.
arcpy.ImportToolbox(utility_service)

#Call the tool to get the limits for the FindRoutes tool 
result = arcpy.Utilities.GetToolInfo("asyncRoute", "FindRoutes")

#Print any warning or error messages returned from the tool
result_severity = arcpy.GetMaxSeverity()
if result_severity == 2:
    arcpy.AddMessage("An error occured when running the tool")
    arcpy.AddMessage(arcpy.GetMessages(2))
    sys.exit(2)
elif result_severity == 1:
    arcpy.AddMessage("Warnings were returned when running the tool")
    arcpy.AddMessage(arcpy.GetMessages(1))

#Retrieve the tool info and convert it to a dictionary
output_tool_info_json = result.getOutput(0)
output_tool_info_dict = json.loads(output_tool_info_json)

#Retrieve the maximum number of stops allowed by the service
max_stops = int(output_tool_info_dict["serviceLimits"]["maximumStops"])
arcpy.AddMessage("The maximum number of stops supported by the FindRoutes tool: {}" .format(max_stops))

Umgebungen

Dieses Werkzeug verwendet keine Geoverarbeitungsumgebungen.