名称 | 说明 | 数据类型 |
in_trace_network | 将运行追踪的追踪网络。 在使用企业级地理数据库时,输入追踪网络必须来自要素服务;不支持来自数据库连接的追踪网络。 | Trace Network; Trace Network Layer |
trace_type | 指定要执行的追踪的类型。 - CONNECTED—将使用从一个或多个起点开始并沿着已连接要素向外跨越的已连接追踪。
- UPSTREAM—将使用能够发现网络中某位置上游的要素的上溯追踪。 这种类型的追踪需要设置流向。
- DOWNSTREAM—将使用能够发现网络中某位置下游的要素的下溯追踪。 这种类型的追踪需要设置流向。
- SHORTEST_PATH—将使用可查找网络中两个起点之间的最短路径(无论流向为何)的最短路径追踪。 遍历路径的成本取决于为 shortest_path_network_attribute_name 参数设置的网络属性。
| String |
starting_points | 使用追踪位置窗格中的起点选项卡创建的要素图层,或包含一个或多个表示追踪起点的记录的表或要素类。 在使用追踪位置窗格中的起点工具创建起点时,默认情况下,将使用 TN_Temp_Starting_Points 要素类,并在工程的默认地理数据库中生成该要素类。 | Feature Layer; Table View |
barriers (可选) | 包含一个或多个要素,表示防止追踪遍历超出此点的追踪障碍的表或要素类。 在使用追踪位置窗格中的障碍工具创建障碍时,默认情况下,将使用 TN_Temp_Barriers 要素类,并在工程的默认地理数据库中生成该要素类。 | Feature Layer; Table View |
path_direction (可选) | 指定追踪路径的方向。 遍历路径的成本取决于 shortest_path_network_attribute_name 参数值。 此参数仅在运行 SHORTEST_PATH 追踪类型时使用。 - NO_DIRECTION—将使用两个起点之间的路径(无论流向为何)。 这是默认设置。
- PATH_UPSTREAM—将使用两个起点之间的上游路径。
- PATH_DOWNSTREAM—将使用两个起点之间的下游路径。
| String |
shortest_path_network_attribute_name (可选) | 用于计算路径的网络属性的名称。 运行最短路径追踪类型时,使用数字网络属性(例如形状长度)计算最短路径。 基于成本和距离的路径都可以进行计算。 运行最短路径追踪时,需要此参数。 | String |
include_barriers (可选) | 指定追踪结果中是否包含可遍历性障碍要素。 - INCLUDE_BARRIERS—追踪结果中将包含可遍历性障碍要素。 这是默认设置。
- EXCLUDE_BARRIERS—追踪结果中将不包含可遍历性障碍要素。
| Boolean |
validate_consistency (可选) | 指定如果在任何遍历的要素中遇到脏区是否返回错误。 这是保证追踪通过网络中状态一致要素的唯一方法。 要移除脏区,请验证网络拓扑。 - VALIDATE_CONSISTENCY—如果在任何遍历的要素中遇到脏区,追踪将返回错误。 这是默认设置。
- DO_NOT_VALIDATE_CONSISTENCY—无论是否在遍历的要素中遇到脏区,追踪都将返回结果。
| Boolean |
ignore_barriers_at_starting_points (可选) | 指定是否在追踪配置中忽略起点处的障碍。 - IGNORE_BARRIERS_AT_STARTING_POINTS—追踪过程中将忽略起点处的障碍。
- DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS—追踪过程中不会忽略起点处的障碍。 这是默认设置。
| Boolean |
allow_indeterminate_flow (可选) | 指定是否追踪具有不确定或未初始化流向的要素。 此参数仅在运行上游追踪或下游追踪时使用。 - TRACE_INDETERMINATE_FLOW—将追踪具有不确定流向或未初始化流向的要素。
- IGNORE_INDETERMINATE_FLOW—不会追踪具有不确定流向或未初始化流向的要素。 这是默认设置。
| Boolean |
condition_barriers [Name, Operator, Type, Value, Combine Using,...] (可选) | 基于与网络属性的比较,对要素设置可遍历性障碍条件。 条件障碍使用网络属性、运算符和类型以及属性值。 例如,当要素的 Code 属性等于 ArtificialPath 的特定值时,将停止追踪。 当要素满足此条件时,追踪将停止。 如果要使用多个属性,可使用 Combine Using 组件来定义 And 或 Or 条件。 条件障碍组件如下: - Name - 按系统中定义的任何网络属性进行过滤。
- Operator - 从大量不同的运算符中进行选择。
- Type - 从在 Name 组件中指定的值中选择特定值或网络属性。
- Value - 提供会基于运算符值导致终止的输入属性类型的特定值。
- Combine Using - 如果要添加多个属性,则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。
Operator 组件如下: - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
Type 组件如下: - SPECIFIC_VALUE—按特定值过滤。
- NETWORK_ATTRIBUTE—按网络属性过滤。
Combine Using 组件如下: - AND—合并条件障碍。
- OR—满足任一条件障碍时使用。
| Value Table |
function_barriers [Function, Attribute, Operator, Value, Use Local Values,...] (可选) | 基于函数对要素设置可遍历性障碍。 函数障碍可用于执行以下操作:限制追踪距离起点的行程或设置停止追踪的最大值。 例如,所经过的每条线的长度和为目前经过的总距离。 当经过的总长度达到指定值时,追踪将停止。 函数障碍组件如下: - Function - 从大量计算函数中进行选择。
- Attribute - 选择按系统中定义的任何网络属性进行过滤。
- Operator - 从大量运算符中进行选择。
- Value - 提供将导致终止的输入属性类型(若发现)的特定值。
- Use Local Values - 计算每个方向的值,而不是整体全局值。 例如,对于计算形状长度总和的函数障碍,如果值大于或等于 4,则追踪终止。 在全局情况下,遍历两条值为 2 的边之后,形状长度总和即已达到 4,因此追踪会停止。 如果使用本地值,每条路径上的本地值会变化,且追踪将继续。
Function 组件如下: - AVERAGE—输入值的平均值。
- COUNT—要素数目。
- MAX—输入值的最大值。
- MIN—输入值的最小值。
- ADD—加上这些值。
- SUBTRACT—减去这些值。
Operator 组件如下: - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
Use Local Values 组件如下: - TRUE—使用本地值。
- FALSE—使用全局值。 这是默认设置。
| Value Table |
traversability_scope (可选) | 指定将应用的可遍历性类型。 可遍历性范围用于确定是否在交汇点和/或边处应用可遍历性。 例如,在游憩步道网络中,如果条件障碍定义为当路径类型为“砾石”并且可遍历性范围设置为仅交汇点时停止追踪,则即使遇到砾石路径,追踪也不会停止,因为该路径类型仅适用于边。 - BOTH_JUNCTIONS_AND_EDGES—可遍历性将同时应用于交汇点和边。 这是默认设置。
- JUNCTIONS_ONLY—可遍历性将仅应用于交汇点。
- EDGES_ONLY—可遍历性将仅应用于边。
| String |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (可选) | 将应用于追踪结果的计算函数。
函数组件如下: - Function - 从大量计算函数中进行选择。
- Attribute - 选择按系统中定义的任何网络属性进行过滤。
- Filter Name - 按属性名称过滤函数结果。
- Filter Operator - 从大量运算符中进行选择。
- Filter Type - 从大量的过滤类型中进行选择。
- Filter Value - 提供输入过滤属性的特定值。
Function 组件选项如下: - AVERAGE—输入值的平均值。
- COUNT—要素数目。
- MAX—输入值的最大值。
- MIN—输入值的最小值。
- ADD—各值的总和。
- SUBTRACT—各值之间的差值。
例如,起点要素的值为 20。 下一个要素的值为 30。 如果您正在使用 MIN 函数,则结果为 20;使用 MAX 函数,结果为 30;使用 ADD 函数,结果为 50;使用 AVERAGE 函数,结果为 25;使用 COUNT 函数,结果为 2;使用 SUBTRACT 函数,结果为 -10。 Filter Operator 组件选项如下: - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN—属性小于值。
Filter Type 组件选项如下: - SPECIFIC_VALUE—按特定值过滤。
- NETWORK_ATTRIBUTE—按网络属性过滤。
| Value Table |
output_conditions [[Name, Operator, Type, Value, Combine Using],...] (可选) | 根据网络属性返回的要素类型。 例如,如果将追踪配置为“过滤掉除水龙头要素外的所有要素”,那么未分配“水龙头”属性的追踪要素均不会包含在结果中。 任何追踪的要素都会返回到结果选择集中。 如果要使用多个属性,可使用 Combine Using 选项来定义 And 或 Or 条件。
输出条件组件如下: - Name - 按系统中定义的任何网络属性进行过滤。
- Operator - 从大量运算符中进行选择。
- Type - 从在 Name 组件中指定的值中选择特定值或网络属性。
- Value - 提供会基于运算符值导致终止的输入属性类型的特定值。
- Combine Using - 如果要添加多个属性,则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。
Operator 组件选项如下: - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN—属性小于值。
Type 组件选项如下: - SPECIFIC_VALUE—按特定值过滤。
- NETWORK_ATTRIBUTE—按网络属性过滤。
Combine Using 组件选项如下: | Value Table |
result_types [result_types,...] (可选) | 指定追踪返回的结果的类型。 - SELECTION—追踪结果将作为相应网络要素上的选择集返回。 这是默认设置。
- AGGREGATED_GEOMETRY—追踪结果按几何类型聚合,并存储在活动地图的图层中显示的要素类中。
- NETWORK_LAYERS—追踪结果将被作为图层组内的选择集添加到要素图层。
- CONNECTIVITY—追踪结果将作为指定输出 .json 文件中的连通图返回。 此选项将启用 out_json_file 参数。
- ELEMENTS—追踪结果将作为指定输出 .json 文件中的要素元素返回。 此选项将启用 out_json_file 参数。
| String |
selection_type | 指定如何应用所选内容以及如果已存在当前内容要执行的操作。 - NEW_SELECTION—生成的选择内容将替换当前选择内容。 这是默认设置。
- ADD_TO_SELECTION—当存在一个选择内容时,会将生成的选择内容添加到当前选择内容中。 如果不存在选择内容,该选项的作用与新选择内容选项的作用相同。
- REMOVE_FROM_SELECTION—将生成的选择内容从当前选择内容中移除。 如果不存在选择内容,该选项不起作用。
- SUBSET_SELECTION—将生成的选择内容与当前选择内容进行组合。 仅两者共有的记录保持选中状态。
- SWITCH_SELECTION—生成的选择内容将被切换。 将所选的结果从当前选择内容中移除,同时将未选取的结果添加到当前选择内容中。 如果不存在选择内容,该选项的作用与新选择内容选项的作用相同。
| String |
clear_all_previous_trace_results (可选) | 指定将内容从选定用来存储聚合几何的要素类中截断,还是追加到该要素类中。 此参数仅适用于聚合几何结果类型。 - CLEAR_ALL_PREVIOUS_TRACE_RESULTS—将截断用于存储聚合追踪几何的要素类。 将仅写入当前追踪操作的输出几何。 这是默认设置。
- DO_NOT_CLEAR_ALL_PREVIOUS_TRACE_RESULTS—当前追踪操作的输出几何将追加到用于存储聚合几何的要素类。
| Boolean |
trace_name (可选) | 追踪操作的名称。 此值将存储在输出要素类的 TRACENAME 字段中,以协助识别追踪结果。 此参数仅适用于聚合几何结果类型。 | String |
aggregated_points (可选) | 包含聚合结果几何的输出多点要素类。 默认情况下,将使用名为 Trace_Results_Aggregated_Points 的系统生成要素类填充该参数,该要素类将存储在工程的默认地理数据库中。
如果该要素类不存在,则系统会自动创建。 也可以使用现有要素类存储聚合几何。 如果使用非默认要素类,则该要素类必须是多点要素类,并且包含名为 TRACENAME 的字符串字段。 此参数仅适用于聚合几何结果类型。
| Feature Class |
aggregated_lines (可选) | 包含聚合结果几何的输出折线要素类。 默认情况下,将使用名为 Trace_Results_Aggregated_Lines 的系统生成要素类填充该参数,该要素类将存储在工程的默认地理数据库中。
如果该要素类不存在,则系统会自动创建。 也可以使用现有要素类存储聚合几何。 如果使用非默认要素类,则该要素类必须是折线要素类,并且包含名为 TRACENAME 的字符串字段。 此参数仅适用于聚合几何结果类型。
| Feature Class |
out_network_layer (可选) | 输出图层组的名称,其中包含具有由追踪返回的要素选择集的要素图层。 该图层将提供在 模型构建器 和 Python 中使用追踪输出的访问权限。
此参数仅适用于网络图层结果类型。
| Group Layer |
use_trace_config (可选) | 指定是否将使用现有指定追踪配置来填充追踪工具的参数。 - USE_TRACE_CONFIGURATION—将使用现有指定追踪配置来定义追踪的属性。 将忽略除 trace_config_name、starting_points 和 barriers 之外的所有参数。
- DO_NOT_USE_TRACE_CONFIGURATION—不使用现有指定追踪配置来定义追踪的属性。 这是默认设置。
| Boolean |
trace_config_name (可选) | 将用于定义追踪属性的追踪配置的名称。 仅当将 use_trace_config 参数设置为 USE_TRACE_CONFIGURATION 时,才会启用此参数。 | String |
out_json_file (可选) | 将生成的 .json 文件的名称和位置。 | File |