WasteCollection

汇总

此 ArcPy 类用于废弃物收集路径规划。

讨论

可通过废弃物收集分析优化城市的废弃物收集工作。 此分析可用于为从同一位置出发并在一天内服务于一个地区的车队规划路径。

了解有关废弃物收集分析的详细信息

详细了解如何使用 arcpy.nax 执行网络分析

语法

WasteCollection(in_network)

名称	说明	数据类型
in_network	将用于网络分析的网络数据集。 可以使用以下方法之一指定该参数： 网络数据集的目录路径 网络数据集图层 对象 网络数据集图层的字符串名称 NetworkDataset 对象 网络必须至少具有一个出行模式、一个具有时间单位的成本属性和一个具有距离单位的成本属性。	String

属性

名称	说明	数据类型
allowAutoRelocate （读取和写入）	指定是否可以在求解时自动重定位具有现有网络位置字段的输入，以确保分析的位置字段有效并且可路由。 如果值为 True ，则位于限制网络元素上的点和受障碍影响的点将重定位至最近的可路由位置。 如果值为 False ，则网络位置字段将按原样使用（即使点无法访问），并且这可能会导致求解失败。 即使值为 False ，没有位置字段或位置字段不完整的输入也会在求解时定位。 默认值为 True 。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。 了解有关网络位置字段以及如何在网络中定位输入的详细信息 如果网络数据源是 ArcGIS Online、不支持使用网络位置字段的 ArcGIS Enterprise 门户或运行版本低于 11.0 的 ArcGIS Enterprise 的门户，则设置此属性会返回错误。	Boolean
directionsLanguage （读取和写入）	将显示输出转弯方向文本的语言。 返回该属性并将表示受支持方向语言的两个或五个字符的语言代码之一设置为字符串。 可从 arcpy.nax.ListDirectionsLanguages 函数中获得可用的方向语言列表。 默认值为 en （英语）或当前激活的语言包的语言。	String
distanceUnits （读取和写入）	报告分析输出中的行驶距离时要使用的单位。 无论网络数据集中成本属性的单位如何，输出都将转换为此属性中设置的单位并以该单位进行报告。 将返回该属性并将其设置为 DistanceUnits 枚举的成员。 默认值为 DistanceUnits.Kilometers 。 注意： 当分析使用服务作为其网络数据源时， DistanceUnits.Decimeters 、 DistanceUnits.Centimeters 、 DistanceUnits.Millimeters 和 DistanceUnits.Inches 单位不受支持。	Object
maxRouteTotalTime （读取和写入）	每条路径允许的最大总时间。 值可为任意正数。 值用于 Routes 类中 MaxTotalTime 字段为空值时的所有路径。 如果未指定任何值，则 Routes 类中的所有行必须包括 MaxTotalTime 字段中的一个值。 值以 timeUnits 属性中指定的单位进行解释。	Double
networkDataSource （只读）	网络数据集的完整目录路径或用于分析的服务的 URL。	String
overrides （读取和写入）	注: 此属性仅限内部使用。	String
routeStartTime （读取和写入）	默认的路径开始时间。 此时间用于 Routes 类中 StartTime 字段为空值时的所有路径。 如果未指定任何值，则 Routes 类中的所有行必须包括 StartTime 字段中的一个值。 使用此属性的 datetime.time 对象。	DateTime
searchSources （读取和写入）	当在网络中定位输入时，此属性指定要使用的网络源列表和（可选）查询以将搜索限制为源要素类内的一部分要素。 默认值位于所有网络边源上，而不是网络交汇点源上。 默认情况下，不对任何源使用查询。 注意： 如果任何停靠点位于交汇点，则求解操作将失败。 该属性值被指定为具有嵌套列表的列表，每个网络源最多具有一个条目。 每个内部列表由两个值组成，分别表示网络源的名称和用作该源的查询的 SQL 表达式。 网络源组件的可能值为参与网络的边源和交汇点源的字符串要素类名称。 列表中的源将用于定位，而不在列表中的源将不会用于定位。 查询在不想查找可能不适合网络位置的要素时很有用。 例如，如果您不想定位在高速公路坡道上，则可定义一个查询将其排除。 对于查询组件，请参阅 在 ArcGIS 中使用的查询表达式的 SQL 参考 获取正确表达式。 空字符串 "" 表示不查询特定源。 例如，值 [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]] 指定输入可以位于 Streets 和 Streets_ND_Junctions 源上。 Streets 源要素类的 SQL 表达式禁止输入位于 ROAD_CLASS 字段的值为 3 的街道上。 不会将查询用于 Streets_ND_Junctions 源要素类。 值 [["Streets", "ROAD_CLASS <> 3"]] 表示应仅将 Streets 源要素类用于定位，不应使用 Streets_ND_Junctions 。 此外，还会将查询应用于 Streets 。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。 了解有关在网络中定位输入的详细信息	String
searchTolerance （读取和写入）	在网络上定位输入要素将使用的最大搜索距离。 返回该属性并将其设置为双精度，然后通过 searchToleranceUnits 属性访问该值的单位。 默认值为 5000。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。 了解有关在网络中定位输入的详细信息	Double
searchToleranceUnits （读取和写入）	指定 searchTolerance 属性的单位。 将返回该属性并将其设置为 DistanceUnits 枚举的成员。 默认值为 DistanceUnits.Meters 。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。	Object
stopCollectionMode （读取和写入）	每个停靠点的默认停靠点收集模式。 将返回该属性并将其设置为 StopCollectionMode 枚举的成员。 值用于 Stops 类中 CollectionMode 字段为空值时的所有停靠点。 如果未指定任何值，则 Stops 类中的所有行必须指定 CollectionMode 字段中的一个值。	Object
timeUnits （读取和写入）	指定报告分析输出中的行驶时间时要使用的单位。 无论网络数据集中成本属性的单位如何，输出都将转换为使用在此属性中设置的单位并以该单位进行报告。 将返回该属性并将其设置为 TimeUnits 枚举的成员。 默认值为 TimeUnits.Minutes 。	Object
travelMode （读取和写入）	要用于分析的出行模式。 出行模式的阻抗属性必须具有时间单位。 对于废弃物收集分析，必须在死胡同处允许调头。 如果出行模式不允许调头，则求解程序将放宽出行模式的调头策略以允许在死胡同处调头。 选择合适的出行模式对于生成良好的废弃物收集分析结果尤为重要，因为垃圾车通常行驶在私人车辆不允许通行的街道上，例如私家路、禁止通行的街道和需要通过上锁的大门进入的道路。 将返回该值并将其设置为 arcpy.nax.TravelMode 对象，但也可以使用出行模式的字符串名称或包含出行模式的有效 JSON 表示的字符串进行设置。 默认为用于分析的网络数据集上定义的默认出行模式。 了解有关出行模式的详细信息	Object

方法

addFields(input_type, field_description[field_description,...])

将自定义字段添加到指定的输入类。 这些字段将包含在通过 fieldMappings 方法创建的字段映射字典中，也可与 insertCursor 方法配合使用。

详细了解如何在分析输入中使用自定义字段

名称	说明	数据类型
input_type	The type of input to which the fields will be added. 使用 WasteCollectionInputDataType 枚举设置此参数。	Object
field_description[field_description,...]	The fields and their properties that will be added to the input class. The value will be constructed as a list of lists with each row containing the following items: Field name—The name of the field that will be added to the input class. Field type—The type of the new field. Field alias—The alternate display name for the field name. Field length—The length of the field being added. This sets the maximum number of allowable characters for each record of the field. This option is only applicable to fields of type text. The default length is 255. Default value—The default value of the field. Available field types are as follows: Field type Description TEXT 此字段类型将为文本类型。 文本字段支持字符串。 FLOAT 此字段类型将为浮点型。 浮点型字段支持介于 -3.4E38 和 1.2E38 之间的小数。 DOUBLE 此字段类型将为双精度型。 双精度型字段支持介于 -2.2E308 和 1.8E308 之间的小数。 SHORT 此字段类型将为短整型。 短整型字段支持介于 -32,768 和 32,767 之间的整数。 LONG 此字段类型将为长整型。 长整型字段支持介于 -2,147,483,648 和 2,147,483,647 之间的整数。 DATE 此字段类型将为日期类型。 日期字段支持日期和时间值。 GUID 此字段类型将为 GUID。 GUID 字段可存储注册表样式的字符串，该字符串包含用大括号括起来的 36 个字符。 BIGINTEGER 此字段类型将为大整型。 大整型字段支持介于 -(253) 和 253 之间的整数。 TIMEONLY 此字段类型仅限时间。 仅时间字段支持不带日期值的时间值。 DATEONLY 此字段类型仅限日期。 仅日期字段支持不带时间值的日期值。 TIMESTAMPOFFSET 此字段类型将为时间戳偏移。 时间戳偏移字段支持日期、时间和相对于 UTC 值的偏移。 Only the field name and type are required. Use None as a place holder for any of the other parameters to accept the default or if the parameter does not apply to the specified field type. The method will return an error if the field already exists in the table or if any of the field properties are invalid.	TEXT

count(input_type)

返回为输入类型添加的行数。

名称	说明	数据类型
input_type	用于计数的输入要素类型。 使用 WasteCollectionInputDataType 枚举设置此参数。	Object

返回值

数据类型	说明
Integer	行数。

fieldMappings(input_type, {use_location_fields}, {list_candidate_fields[list_candidate_fields,...]})

生成将输入类型的字段名称映射到 arcpy.nax.NAClassFieldMap 对象的 NAClassFieldMappings 字典，以允许您将字段从输入数据映射到求解程序属性。 字典可用作 load 方法的 field_mappings 参数的输入。

了解有关如何在加载输入时使用字段映射的详细信息

名称	说明	数据类型
input_type	The type of input for which the field mappings will be returned. 使用 WasteCollectionInputDataType 枚举设置此参数。 Learn more about the fields available for each input type	Object
use_location_fields （可选）	Specifies whether network location fields will be included in the returned field mappings dictionary. Network location fields describe the point on the network where an object is located. You can use network location fields to more precisely control how analysis inputs locate on the network and to save time when calling the solve method because the solver will not have to calculate the location fields from the geometry of the inputs. You can calculate location fields for a feature class using the Calculate Locations tool. Learn more about network location fields and how inputs are located on the network When this argument is set to True, the returned field mappings dictionary will include network location fields. The default is False, which means the field mapping dictionary will not include network location fields. (默认值为 False)	Boolean
list_candidate_fields[list_candidate_fields,...] （可选）	Use this parameter to map additional, nondefault fields from the input data to the analysis inputs. For example, if the input feature class contains a field named MyField, and you want it to be included in the analysis inputs, pass the MyField field object to the list_candidate_fields parameter. MyField will be included in the returned field mapping dictionary and automatically mapped. When you call the load method using these field mappings, MyField will be included in the analysis inputs along with all the default fields. In many cases, these extra fields will be passed to the analysis output as well. Specify this parameter as a list of arcpy.Field objects, which can be obtained from a specified feature class or table using the arcpy.ListFields function. Learn more about best practices for setting up analysis inputs 旧版本： If the network data source is an ArcGIS Enterprise portal, the method will return an error if any of the fields specified are of a type that is not supported by the portal version. (默认值为 None)	Field

返回值

数据类型	说明
Dictionary	NAClassFieldMappings 字典，其中键为字段名称，值为 arcpy.nax.NAClassFieldMap 对象。

fieldNames(input_type, {use_location_fields})

获取指定输入类型支持的字段名称列表。

名称	说明	数据类型
input_type	返回其支持的字段名称的输入类型。 使用 WasteCollectionInputDataType 枚举设置此参数。 Learn more about the fields available for each input type	Object
use_location_fields （可选）	指示网络位置字段是否包含在返回的字段名称列表中。网络位置字段可描述网络中对象所在的点。您可以使用网络位置字段更精确地控制分析输入在网络上的定位方式，并且由于求解程序不必从输入的几何计算位置字段，因此在调用 solve 方法时可以节省时间。您可以使用 计算位置 工具计算要素类的位置字段。 了解有关网络位置字段以及如何在网络中定位输入的详细信息 当此参数设置为 True 时，返回的字段名称列表将包含网络位置字段。默认为 False ；字段名称列表不包括网络位置字段。 (默认值为 False)	Boolean

返回值

数据类型	说明
String	指定输入类型支持的字段名称列表。

insertCursor(input_type, field_names[field_names,...], {append})

在指定的输入类型上建立写入光标。 此游标可用于将行直接添加到输入。

详细了解如何插入输入

名称	说明	数据类型
input_type	The type of input into which the cursor can be used to insert rows. 使用 WasteCollectionInputDataType 枚举设置此参数。	Object
field_names[field_names,...]	A list of field names of the input type whose values you want to set when inserting rows using the cursor. You can get the names of the fields supported by an input type using the fieldNames method. Learn more about the fields available for each input type In addition to regular fields, you can also set the geometry of the input using one of the following geometry tokens: SHAPE@XY—A tuple of the feature's centroid x,y coordinates. SHAPE@XYZ SHAPE@JSON— The esri JSON string representing the geometry. SHAPE@WKB—The well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes. SHAPE@WKT—The well-known text (WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string. SHAPE@—A geometry object for the feature. The SHAPE@XY and SHAPE@XYZ tokens are only supported for point-based input types. When using the SHAPE@XY and SHAPE@XYZ tokens, specify the x-, y-, and z-values in the spatial reference of the network data source being used in the analysis.	String
append （可选）	Specifies whether the features being inserted will be appended to the existing set of features for the input type. A value of True indicates that the new features will be appended; the existing features will be preserved. This is the default. A value of False indicates that any existing features for the input type will be deleted and replaced with the features being inserted. (默认值为 True)	Boolean

返回值

数据类型	说明
Object	可用于写入要素的 SolverInsertCursor 对象。

load(input_type, features, {field_mappings}, {append}, {max_features})

设置用于分析的输入要素。

详细了解如何加载输入

名称	说明	数据类型
input_type	The type of input feature that will be loaded. 使用 WasteCollectionInputDataType 枚举设置此参数。	Object
features	The input features that will be loaded. This parameter accepts the following input types: The catalog path to a feature class or a table A Layer object The string representing the name of a layer A FeatureSet or RecordSet object For layer inputs, only selected features will be loaded. If a layer has a definition query, only the subset of features visible with the definition query will be loaded. The method also honors the Extent geoprocessing environment; only features in the specified extent will be loaded.	String
field_mappings （可选）	An NAClassFieldMappings dictionary that maps the field names of the input type to arcpy.nax.NAClassFieldMap objects representing the mapping of fields from the input features. Valid input for this parameter can be constructed using the fieldMappings method. If no field mappings are specified, all fields from the input features that have the same name as the supported fields for the input type will be mapped. Learn more about the fields available for each input type (默认值为 None)	Dictionary
append （可选）	Specifies whether the features being loaded will be appended to the existing set of features for the input type. A value of True indicates that the new features will be appended, and existing features will be preserved. This is useful when loading inputs from multiple feature classes or tables to use in a single analysis. This is the default. A value of False indicates that any existing features for the input type will be deleted and replaced with the features currently being loaded. (默认值为 True)	Boolean
max_features （可选）	The maximum number of features that can be loaded into the input type. This is useful if you are creating a tool or service and want an error returned if the size of the input exceeds the available resources. The load method will return an arcpy.nax.LimitError if the number of input features exceeds the max_features limit. If no value is provided, no limit will be enforced for the count of the input features. (默认值为 None)	Integer

setLocateSettingsOverrides(input_type, {search_sources[[Source, Expression],...]}, {allow_auto_relocate}, {search_tolerance}, {search_tolerance_units})

为指定输入类设置定位设置，并覆盖为分析指定的默认定位设置。 如果想要使用不同的规则定位不同的输入，这非常有用。 例如，在 OD 成本矩阵分析中，如果搜索查询不需要应用于输入目标和障碍，则可以使用仅应用于输入源的搜索查询。

可使用此方法覆盖指定输入类的 searchSources 、 allowAutoRelocate 、 searchTolerance 和 searchToleranceUnits 属性值。

了解有关在网络中定位输入的详细信息

名称	说明	数据类型
input_type	The type of input for which to override default locate settings. 使用 WasteCollectionInputDataType 枚举设置此参数。	Object
search_sources[[Source, Expression],...] （可选）	The list of network sources to be used when locating inputs of the designated type on the network, and, optionally, a query to restrict the search to a subset of the features within a source feature class. See the documentation for the searchSources property for examples of proper syntax for this parameter. Specifying a value for this parameter overrides the default searchSources property value for the designated input type. If this parameter is not specified or is set to None, the searchSources value will be used for this input type. 注意： The solve will fail if any stops are located on junctions.	String
allow_auto_relocate （可选）	Specifies whether inputs of the designated type with existing network location fields can be automatically relocated at solve time to ensure valid, routable location fields for the analysis. If the value is True, points located on restricted network elements and points affected by barriers will be relocated to the closest routable location. If the value is False, network location fields will be used as is, even if the points are unreachable, and this may cause the solve to fail. Even if the value is False, inputs with no location fields or incomplete location fields will be located at solve time. Specifying a value for this parameter overrides the default allowAutoRelocate property value for the designated input type. If this parameter is not specified or is set to None, the allowAutoRelocate value will be used for this input type. The method returns an error if the network data source is ArcGIS Online. The method returns an error if the network data source is an ArcGIS Enterprise portal that does not support using network location fields.	Boolean
search_tolerance （可选）	The maximum search distance to use when locating inputs of the designated type on the network. Specifying a value for this parameter overrides the default searchTolerance property value for the designated input type. If this parameter is not specified or is set to None, the searchTolerance value will be used for this input type. The units of this parameter value are set using the search_tolerance_units parameter; however, if no value is set for that parameter, the search_tolerance value will be interpreted in the units specified in the searchToleranceUnits property. This parameter does not apply to line and polygon barriers; the method will return an error if this parameter is specified when the input_type value is one of these barrier types.	Double
search_tolerance_units （可选）	The units of the maximum search distance when locating inputs of the designated type of the network. The parameter is specified using a member of the DistanceUnits enumeration. Specifying a value for this parameter overrides the default searchToleranceUnits property value for the designated input type. If this parameter is not specified or is set to None, the searchToleranceUnits will be used for this input type. The value specified using the search_tolerance parameter is interpreted using these units. If that parameter is not specified, the value of the searchTolerance property will be interpreted using these units for the designated input type only. This parameter does not apply to line and polygon barriers; the method will return an error if this parameter is specified when the input_type value is one of these barrier types.	Double

solve()

使用在 WasteCollection 对象上设置的属性和已加载的输入执行废弃物收集分析。

返回值

数据类型	说明
Object	arcpy.nax.WasteCollectionResult 对象可用于访问输出和求解器消息。

代码示例

WasteCollection 示例

使用要素类和表中的输入执行废弃物收集分析。

# An example showing how to perform waste collection analysis using inputs
# from feature classes and tables.
import datetime
import arcpy

# Define inputs
nds = "C:/data/MyCity.gdb/Routing/Routing_ND"
nd_layer_name = "Routing_ND"
input_stops = "C:/data/io.gdb/BinLocations"
input_depots = "C:/data/io.gdb/Depots"
input_routes = "C:/data/io.gdb/Trucks"
input_renewals = "C:/data/io.gdb/Landfill"
input_route_renewals = "C:/data/io.gdb/RouteRenewals"

# Define outputs
output_stops = "C:/data/io.gdb/OutputBins"
output_routes = "C:/data/io.gdb/OutputTrucks"

# Create a network dataset layer and get the desired travel mode for analysis
arcpy.nax.MakeNetworkDatasetLayer(nds, nd_layer_name)
nd_travel_modes = arcpy.nax.GetTravelModes(nd_layer_name)
# travel_mode = nd_travel_modes["Garbage Truck Time"]
travel_mode = nd_travel_modes["Driving Time"]

# Instantiate a WasteCollection solver object
waste_collection = arcpy.nax.WasteCollection(nd_layer_name)
# Set properties
waste_collection.travelMode = travel_mode
waste_collection.stopCollectionMode = arcpy.nax.StopCollectionMode.OneSide
waste_collection.routeStartTime = datetime.time(6, 0, 0)
waste_collection.timeUnits = arcpy.nax.TimeUnits.Hours
waste_collection.maxRouteTotalTime = 6  # hours
# Load inputs
waste_collection.load(arcpy.nax.WasteCollectionInputDataType.Stops, input_stops)
waste_collection.load(arcpy.nax.WasteCollectionInputDataType.Depots, input_depots)
waste_collection.load(arcpy.nax.WasteCollectionInputDataType.Routes, input_routes)
waste_collection.load(arcpy.nax.WasteCollectionInputDataType.Renewals, input_renewals)
waste_collection.load(arcpy.nax.WasteCollectionInputDataType.RouteRenewals, input_route_renewals)
# Solve the analysis
result = waste_collection.solve()

# Export the results to feature classes
if result.solveSucceeded:
    result.export(arcpy.nax.WasteCollectionOutputDataType.Stops, output_stops)
    result.export(arcpy.nax.WasteCollectionOutputDataType.Routes, output_routes)
else:
    print("Solve failed")
    print(result.solverMessages(arcpy.nax.MessageSeverity.All))