摘要
此 ArcPy 类用于执行最后一公里配送分析。
语法
LastMileDelivery (in_network)
| 参数 | 说明 | 数据类型 |
in_network | The network dataset or service that will be used for the network analysis. The argument can be specified using one of the following:
The network must have at least one travel mode, one cost attribute with time units, and one cost attribute with distance units, as well as a time zone attribute. To use a portal URL, you must be signed in to the portal with an account that has routing privileges. When using ArcGIS Online or an ArcGIS Enterprise portal whose routing services are configured usingArcGIS Online as the in_network value, solving the analysis will consume credits and will be subject to certain limits, such as the number of allowed inputs. Learn more about credit consumption and analysis limits in network analysis | String |
属性
| 属性 | 说明 | 数据类型 |
| allowAutoRelocate (可读写) | 指定是否可以在求解时自动重定位具有现有网络位置字段的输入，以确保分析的位置字段有效并且可路由。 如果值为 True，则位于限制网络元素上的点和受障碍影响的点将重定位至最近的可路由位置。 如果值为 False，则网络位置字段将按原样使用（即使点无法访问），并且这可能会导致求解失败。 即使值为 False，没有位置字段或位置字段不完整的输入也会在求解时定位。 默认为 True。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。 如果网络数据源是 ArcGIS Online、不支持使用网络位置字段的 ArcGIS Enterprise 门户或运行版本低于 11.0 的 ArcGIS Enterprise 的门户，则设置此属性会返回错误。 | Boolean |
| allowSaveLayerFile (可读写) | 指定是否允许在结果对象上使用 saveAsLayerFile 方法将分析结果另存为图层文件。 值为 True 表明可以保存图层文件。 值为 False 表明无法保存图层文件。 如果分析引用网络数据集，则默认设置为 True；如果其引用门户服务，则为 False。 如果分析引用门户服务，则保存图层文件可能会降低分析速度。 | Boolean |
| allowSaveRouteData (可读写) | 指定是否将生成路径数据。 True 的值表示求解分析时将生成路径数据。 False 的值表示将不生成路径数据。 使用结果对象上的 saveRouteData 方法将路线数据保存为 .zip 文件。 生成路径数据可能会降低分析速度。 默认为 False。 | Boolean |
| directionsLanguage (可读写) | 将显示输出转弯方向文本的语言。 返回该属性并将表示受支持方向语言的两个或五个字符的语言代码之一设置为字符串。 可从 arcpy.nax.ListDirectionsLanguages 函数中获得可用的方向语言列表。 默认值为 en（英语）或当前激活的语言包的语言。 此属性仅在 returnDirections 属性为 True 时可用。 | String |
| distanceUnits (可读写) | 报告分析输出中的行驶距离时要使用的单位。 无论网络数据集中成本属性的单位如何，输出都将转换为此属性中设置的单位并以该单位进行报告。 将返回该属性并将其设置为 DistanceUnits 枚举的成员。 默认为 DistanceUnits.Kilometers。 | Object |
| earliestRouteStartDate (可读写) | 默认的路径最早开始日期。 此日期用于 Routes 类中 EarliestStartDate 字段为空值时的所有路径。 如果没有为此属性指定值，则 Routes 类中的所有行必须包括 EarliestStartDate 字段中的一个值。 使用此属性的 datetime.date 对象。 警告：尽管其他 Network Analyst 求解程序允许您使用特殊日期来建模一周中的某一天或当前日期，而不是特定的静态日期，但“最后一公里配送”求解程序却不允许。 必须选择具体日期。 | DateTime |
| earliestRouteStartTime (可读写) | 默认的路径最早开始时间。 此时间用于 Routes 类中 EarliestStartTime 字段为空值时的所有路径。 如果没有指定此属性 d，则 Routes 类中的所有行必须包括 EarliestStartTime 字段中的一个值。 使用此属性的 datetime.time 对象。 | DateTime |
| ignoreInvalidLocations (可读写) | 指定是否忽略无效的输入位置。 值为 True 表示将忽略无效的输入位置，仅使用有效位置即可成功进行分析。 值为 False 表示不会忽略无效位置，从而导致分析失败。 | Boolean |
| maxRouteTotalTime (可读写) | 每条路径允许的最大总时间。 值可为任意正数。 值用于 Routes 类中 MaxTotalTime 字段为空值时的所有路径。 如果没有为此属性指定值，则 Routes 类中的所有行必须包括 MaxTotalTime 字段中的一个值。 值以 timeUnits 属性中指定的单位进行解释。 | Double |
| networkDataSource (只读) | 网络数据集的完整目录路径或用于分析的服务的 URL。 | String |
| overrides (可读写) | 注：此属性仅限内部使用。 | String |
| returnDirections (可读写) | 指定是否将生成转弯方向。 值为 True 表明在求解分析时将生成转弯方向。 值为 False 表明不会生成转弯方向。 生成方向可能会降低分析速度。 默认值为 False。 | Boolean |
| routeShapeType (可读写) | 为表示输出路径而生成的形状类型。 路径沿网络计算；但是，您可以使用不反映网络路径的形状来表示它们。 尽管不支持 RouteShapeType.TrueShape 选项，但属性将返回并设置为 RouteShapeType 枚举的成员。 默认为 RouteShapeType.StraightLine。 | Object |
| 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 方法。 如果网络数据源是 ArcGIS Online 或运行版本低于 11.0 的 ArcGIS Enterprise 的门户，则设置此属性会返回错误。 | String |
| searchTolerance (可读写) | 在网络上定位输入要素将使用的最大搜索距离。 返回该属性并将其设置为双精度，然后通过 searchToleranceUnits 属性访问该值的单位。 默认值为 5000。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。 旧版本：如果网络数据源是运行版本低于 11.0 的 ArcGIS EnterpriseArcGIS Enterprise 的门户，则设置此属性会返回错误。 | Double |
| searchToleranceUnits (可读写) | searchTolerance 属性的单位。 将返回该属性并将其设置为 DistanceUnits 枚举的成员。 默认为 DistanceUnits.Meters。 此属性会影响所有输入类型的定位。 要更改单个输入类型的此属性，请使用 setLocateSettingsOverrides 方法。 旧版本：如果网络数据源是运行版本低于 11.0 的 ArcGIS EnterpriseArcGIS Enterprise 的门户，则设置此属性会返回错误。 | Object |
| sequenceGap (可读写) | 求解分析时，Orders 类中的 Sequence 字段相邻停靠点的字段中保留的数值间距。 该值作为各个路径上停靠点序列的乘数。 例如，如果间距为 5，则路径上的第一个停靠点的 Sequence 字段值为 5，路径上第二个停靠点的 Sequence 字段值为 10，第三个为 15，以此类推。 此属性有助于在初始路径计划创建后插入停靠点，因为新的停靠点可以插入序列间距中。 值必须为正整数。 默认值为 1。 首次求解分析时，Sequence 字段值将使用指定的序列间距填充顺序值。 在同一分析的后续求解中，将保留现有停靠点的 Sequence 字段值，新的停靠点会将未被其他停靠点使用的可用整数用于 Sequence 字段，插入到间距中。 如果序列间距设置为 1，则每次求解时，序列值会更新为连续的值。 | Integer |
| timeUnits (可读写) | 报告分析输出中的行驶时间时要使用的单位。 无论网络数据集中成本属性的单位如何，输出都将转换为使用在此属性中设置的单位并以该单位进行报告。 将返回该属性并将其设置为 TimeUnits 枚举的成员。 默认为 TimeUnits.Minutes。 | Object |
| timeZoneForTimeFields (可读写) | 指示输入数据中的时间字段是否解释为输入位置的本地时间或协调世界时间 (UTC)。 将返回该属性并将其设置为 TimeZoneUsage 枚举的成员。 默认为 TimeZoneUsage.LocalTimeAtLocations。 | Object |
| travelMode (可读写) | 要用于分析的出行模式。 出行模式的阻抗属性必须具有时间单位。 将返回该值并将其设置为 arcpy.nax.TravelMode 对象，但也可以使用出行模式的字符串名称或包含出行模式的有效 JSON 表示的字符串进行设置。 默认为用于分析的网络数据集上定义的默认出行模式。 | Object |
方法概述
| 方法 | 说明 |
| addFields (input_type, field_description) | 将自定义字段添加到指定的输入类。 这些字段将包含在通过 fieldMappings 方法创建的字段映射字典中，也可与 insertCursor 方法配合使用。 |
| count (input_type) | 返回为输入类型添加的行数。 |
| fieldMappings (input_type, {use_location_fields}, {list_candidate_fields}) | 生成将输入类型名称字段映射到 arcpy.nax.NAClassFieldMap 对象的 NAClassFieldMappings 字典，以允许您将字段从输入数据映射到求解程序属性。 字典可用作 load 方法的 field_mappings 参数的输入。 |
| fieldNames (input_type, {use_location_fields}) | 获取指定输入类型支持的字段名称列表。 |
| insertCursor (input_type, field_names, {append}) | 在指定的输入类型上建立写入光标。 此游标可用于将行直接添加到输入。 |
| load (input_type, features, {field_mappings}, {append}, {max_features}) | 设置用于分析的输入要素。 |
| setLocateSettingsOverrides (input_type, {search_sources}, {allow_auto_relocate}, {search_tolerance}, {search_tolerance_units}) | 为指定输入类设置定位设置，并覆盖为分析指定的默认定位设置。 如果想要使用不同的规则定位不同的输入，这非常有用。 例如，在 OD 成本矩阵分析中，如果搜索查询不需要应用于输入目标和障碍，则可以使用仅应用于输入源的搜索查询。 可使用此方法覆盖指定输入类的 searchSources、allowAutoRelocate、searchTolerance 和 searchToleranceUnits 属性值。 |
| solve () | 使用在 LastMileDelivery 对象上设置的属性和已加载输入执行最后一公里配送分析。 |
方法
addFields (input_type, field_description)
| 参数 | 说明 | 数据类型 | ||||||||||||||||||||||||
input_type |
The type of input to which the fields will be added. 使用 LastMileDeliveryInputDataType 枚举设置此参数。 | 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:
Available field types are as follows:
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. 旧版本：The GUID, BIGINTEGER, TIMEONLY, DATEONLY, and TIMESTAMPOFFSET field types are not supported when the network data source is a portal running ArcGIS Enterprise 11.1.x or earlier. | List |
count (input_type)
| 参数 | 说明 | 数据类型 |
input_type | 用于计数的输入要素类型。 使用 LastMileDeliveryInputDataType 枚举设置此参数。 | Object |
| 数据类型 | 说明 |
| Integer | 行数。 |
fieldMappings (input_type, {use_location_fields}, {list_candidate_fields})| 参数 | 说明 | 数据类型 |
input_type | The type of input for which the field mappings will be returned. 使用 LastMileDeliveryInputDataType 枚举设置此参数。 See descriptions of 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 | 返回其支持的字段名称的输入类型。 使用 LastMileDeliveryInputDataType 枚举设置此参数。 See descriptions of the fields available for each input type | Object |
use_location_fields | 指示网络位置字段是否包含在返回的字段名称列表中。网络位置字段可描述网络中对象所在的点。您可以使用网络位置字段更精确地控制分析输入在网络上的定位方式，并且由于求解程序不必从输入的几何计算位置字段，因此在调用 solve 方法时可以节省时间。您可以使用计算位置工具计算要素类的位置字段。 当此参数设置为 True 时，返回的字段名称列表将包含网络位置字段。默认为 False；字段名称列表不包括网络位置字段。 (默认值为 False) | Boolean |
| 数据类型 | 说明 |
| String | 指定输入类型支持的字段名称列表。 |
insertCursor (input_type, field_names, {append})| 参数 | 说明 | 数据类型 |
input_type | The type of input into which the cursor can be used to insert rows. 使用 LastMileDeliveryInputDataType 枚举设置此参数。 | 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. See descriptions of 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:
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. 使用 LastMileDeliveryInputDataType 枚举设置此参数。 | Object |
features | The input features that will be loaded. This parameter accepts the following input types:
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. See descriptions of 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}, {allow_auto_relocate}, {search_tolerance}, {search_tolerance_units})| 参数 | 说明 | 数据类型 |
input_type | The type of input for which to override default locate settings. 使用 LastMileDeliveryInputDataType 枚举设置此参数。 | 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 method returns an error if this parameter is used and the network data source is ArcGIS Online. | 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 |
代码示例
使用要素类和表的输入执行最后一公里配送分析。
# An example showing how to perform last mile delivery analysis using inputs
# from feature classes and tables.
import datetime
import arcpy
arcpy.CheckOutExtension("network")
nds = "C:/data/NorthAmerica.gdb/Routing/Routing_ND"
nd_layer_name = "Routing_ND"
input_orders = "C:/data/io.gdb/Orders"
input_depots = "C:/data/io.gdb/Depots"
input_routes = "C:/data/io.gdb/Vehicles"
output_orders = "C:/data/io.gdb/OutputOrders"
output_routes = "C:/data/io.gdb/OutputRoutes"
output_direction_points = "C:/data/io.gdb/OutputDirectionPoints"
output_direction_lines = "C:/data/io.gdb/OutputDirectionLines"
# 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["Driving Time"]
# Instantiate a LastMileDelivery solver object
last_mile = arcpy.nax.LastMileDelivery(nd_layer_name)
# Set properties
last_mile.travelMode = travel_mode
last_mile.earliestRouteStartDate = datetime.date(2024, 6, 3)
last_mile.earliestRouteStartTime = datetime.time(8, 0, 0)
last_mile.timeUnits = arcpy.nax.TimeUnits.Hours
last_mile.maxRouteTotalTime = 8 # hours
last_mile.returnDirections = True
# Load inputs
last_mile.load(arcpy.nax.LastMileDeliveryInputDataType.Orders, input_orders)
last_mile.load(arcpy.nax.LastMileDeliveryInputDataType.Depots, input_depots)
last_mile.load(arcpy.nax.LastMileDeliveryInputDataType.Routes, input_routes)
# Solve the analysis
result = last_mile.solve()
# Export the results to feature classes
if result.solveSucceeded:
result.export(arcpy.nax.LastMileDeliveryOutputDataType.Orders, output_orders)
result.export(arcpy.nax.LastMileDeliveryOutputDataType.Routes, output_routes)
result.export(arcpy.nax.LastMileDeliveryOutputDataType.DirectionPoints, output_direction_points)
result.export(arcpy.nax.LastMileDeliveryOutputDataType.DirectionLines, output_direction_lines)
else:
print("Solve failed")
print(result.solverMessages(arcpy.nax.MessageSeverity.All))