在 Standard 或 Advanced 许可等级下可用。
使用方法
输入公共设施网络的版本必须是 5 或更高版本。
使用企业级地理数据库时,输入公用设施网络必须来自公共设施网络服务。
连接的门户帐户设置为追踪配置的创建者。
操作系统身份验证用于在文件地理数据库中使用公共设施网络时存储追踪配置的创建者。
语法
arcpy.un.AddTraceConfiguration(in_utility_network, trace_config_name, trace_type, {description}, {tags}, {domain_network}, {tier}, {target_tier}, {subnetwork_name}, {shortest_path_network_attribute_name}, {include_containers}, {include_content}, {include_structures}, {include_barriers}, {validate_consistency}, {condition_barriers}, {function_barriers}, {traversability_scope}, {filter_barriers}, {filter_function_barriers}, {filter_scope}, {filter_bitset_network_attribute_name}, {filter_nearest}, {nearest_count}, {nearest_cost_network_attribute}, {nearest_categories}, {nearest_assets}, {functions}, {propagators}, {output_assettypes}, {output_conditions}, {include_isolated_features}, {ignore_barriers_at_starting_points}, {include_up_to_first_spatial_container}, {result_types}, {allow_indeterminate_flow}, {validate_locatability})
参数 | 说明 | 数据类型 |
in_utility_network | 包含新的追踪配置的公共设施网络。 | Utility Network; Utility Network Layer |
trace_config_name | 追踪配置的名称。 | String |
trace_type | 指定要配置的追踪类型。
| String |
description (可选) | 追踪配置的描述。 | String |
tags [tags,...] (可选) | 用于标识追踪配置的标签集。可在搜索和索引中使用此类标签。 | String |
domain_network (可选) | 将运行追踪的域网络的名称。运行子网、子网控制器、上溯和下溯追踪类型时,需要此参数。 | String |
tier (可选) | 要开始追踪的层的名称。运行子网、子网控制器、上溯和下溯追踪类型时,需要此参数。 | String |
target_tier (可选) | 输入层流向的目标层名称。如果上溯和下溯追踪的此参数丢失,当到达起始子网边界时,上述追踪将停止。该参数可以使此类追踪在层级结构中继续向上或向下延伸。 | String |
subnetwork_name (可选) | 将运行追踪的子网的名称。运行子网追踪类型时可以使用此参数。如果指定了子网名称,则不需要起点参数(Python 中的 starting_points 参数)。 | String |
shortest_path_network_attribute_name (可选) | 用于计算最短路径的网络属性。运行最短路径追踪类型时,使用数字网络属性(例如形状长度)计算最短路径。基于成本和距离的路径都可以进行计算。运行最短路径追踪时,需要此参数。 | String |
include_containers (可选) | 指定追踪结果中是否包含容器要素。
| Boolean |
include_content (可选) | 指定追踪是否在结果中返回容器的内容。
| Boolean |
include_structures (可选) | 指定追踪结果中是否包含结构要素和对象。
| Boolean |
include_barriers (可选) | 指定追踪结果中是否包含可遍历性障碍要素。即使已在子网定义中进行了预设,可遍历性障碍仍可选。此参数不适用于具备终端的设备要素。
| Boolean |
validate_consistency (可选) | 指定如果在任何遍历的要素中遇到脏区是否返回错误。这是保证追踪通过网络中状态一致要素的唯一方法。要移除脏区,请验证网络拓扑。
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (可选) | 基于与网络属性的比较或对类别字符串的检查,对要素设置可遍历性障碍条件。条件障碍使用网络属性、运算符和类型以及属性值。例如,当要素的 Device Status 属性等于 Open 的特定值时,将停止追踪。当要素满足此条件时,追踪将停止。如果您要使用多个属性,可使用 Combine Using 参数来定义 And 或 Or 条件。 条件障碍组件如下:
条件障碍 operator 值选项如下:
条件障碍 Type 值选项如下:
条件障碍 Combine Using 值选项如下:
| Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (可选) | 基于函数对要素设置可遍历性障碍。函数障碍可用于执行以下操作:限制追踪距离起点的行程或设置停止追踪的最大值。例如,所经过的每条线的长度和为目前经过的总距离。当经过的总长度达到指定值时,追踪将停止。 函数障碍组件如下:
函数障碍 function 值选项如下:
函数障碍 operator 值选项如下:
函数障碍 Use Local Values 选项如下:
| Value Table |
traversability_scope (可选) | 要强制使用的可遍历性的类型。可遍历性范围指明是否在交汇点、边或这两处强制使用可遍历性。例如,如果定义了用于停止追踪的条件障碍,其中 Device Status 等于 Open 并将遍历范围仅设置为边,则即使追踪遇到开路设备,追踪也不会停止,因为 Device Status 仅适用于交汇点。换言之,此参数会为追踪指明是否要忽略交汇点和/或边。
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (可选) | 用于指定针对特定类别或网络属性的追踪停止时间。例如,针对生命周期状态属性等于特定值的要素,追踪停止。此参数用于根据系统中定义的网络属性值设置终止符。如果要使用多个属性,可使用 Combine Using 选项来定义“和”或“或”条件。 过滤器障碍组件如下:
过滤器障碍 operator 值选项如下:
过滤器障碍 Type 值选项如下:
过滤器障碍 Combine Using 值选项如下:
| Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (可选) | 用于过滤特定类别的追踪结果。 过滤器函数障碍组件如下:
过滤器函数障碍 function 值选项如下:
过滤器函数障碍 operator 值选项如下:
过滤器函数障碍 Use Local Values 选项如下:
| Value Table |
filter_scope (可选) | 指定是否在交汇点、边或这两处强制使用特定类别的过滤器。例如,如果定义了用于停止追踪的过滤器障碍,其中 Device Status 等于 Open 并将遍历范围仅设置为边,则即使追踪遇到开路设备,追踪也不会停止,因为 Device Status 仅适用于交汇点。换言之,此参数会为追踪指明是否要忽略交汇点和/或边。
| String |
filter_bitset_network_attribute_name (可选) | 将用于按 bitset 过滤的网络属性的名称。此参数仅适用于上溯、下溯和循环追踪类型。此参数可用于在追踪过程中添加特殊逻辑,以便追踪能够更好地反映真实世界的场景。例如,对于循环追踪而言,Phases current 网络属性可以确定该循环是否为实际的电气循环(相同的相在循环 A 中各处均有电流通过),并且追踪结果只返回实际的电气循环。上溯追踪的示例如下;如果追踪配电网络时指定 Phases current 网络属性,则追踪结果将只包含在网络属性中指定的有效路径,而不是所有路径。 | String |
filter_nearest (可选) | 指定是否使用 k-最近邻算法在给定距离内返回一些特定类型的要素。使用此参数时,您可以指定计数、成本以及类别和/或资产类型的集合。
| Boolean |
nearest_count (可选) | filter_nearest 为 FILTER_BY_NEAREST 状态时要返回的要素数量。 | Long |
nearest_cost_network_attribute (可选) | 当filter_nearest为FILTER_BY_NEAREST状态时,将用于计算接近度、成本或距离的数字网络属性(例如形状长度)。 | String |
nearest_categories [nearest_categories,...] (可选) | 当filter_nearest处于FILTER_BY_NEAREST状态时,将返回的类别(例如保护类别)。 | String |
nearest_assets [nearest_assets,...] (可选) | 当 filter_nearest 处于 FILTER_BY_NEAREST 状态时,将返回的资产组和资产类型(例如,ElectricDistributionDevice/Transformer/Step Down)。 | String |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (可选) | 用于将计算函数应用于追踪结果。 函数组件如下:
函数 Function 值选项如下:
例如,起点要素的值为 20。下一个要素的值为 30。如果使用 MINIMUM 函数,结果为 20;使用 MAXIMUM, 则为 30;ADD,则为 50;AVERAGE,则为 25;COUNT,则为 2;而 SUBTRACT,则为 -10。 Filter Operator 值选项如下:
函数 Filter Type 值选项如下:
| Value Table |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (可选) | 指定要传播的网络属性以及传播将在追踪过程中的发生方式。传播的类属性表示子网控制器上已传播至子网余下要素的关键值。例如,在配电模型中,您可传播相位值。 传播程序组件如下:
传播程序 function 值选项如下:
传播程序 operator 值选项如下:
注:此参数仅可通过 Python 获得。 | Value Table |
output_assettypes [output_assettypes,...] (可选) | 过滤要包含在结果中的输出资产类型 - 例如,仅返回架空变压器。 | String |
output_conditions [[Name, Operator, Type, Value, Combine Using],...] (可选) | 指定按网络属性或类别返回的要素类型。例如,如果将追踪配置为“过滤掉除水龙头要素外的所有要素”,那么未分配水龙头类别的追踪要素均不会包含在结果中。任何追踪的要素都会返回到结果选择集中。如果要使用多个属性,可使用 Combine Using 选项来定义“和”或“或”条件。 输出条件组件如下:
输出条件 operator 值选项如下:
输出条件 Type 值选项如下:
输出条件 Combine Using 值选项如下:
| Value Table |
include_isolated_features (可选) | 指定追踪结果中是否包含孤立要素。此参数仅在运行隔离追踪时使用。
注:在使用企业级地理数据库时,隔离追踪类型需要 ArcGIS Enterprise 10.7 或更高版本。 | Boolean |
ignore_barriers_at_starting_points (可选) | 指定是否在追踪配置中忽略起点处的动态障碍。这在执行上游保护设备追踪并使用所发现的保护设备(屏障)作为起始点以找到后续上游保护设备时可能非常有用。
| Boolean |
include_up_to_first_spatial_container (可选) | 指定是否将所返回的容器限制为仅限追踪结果中每个网络元素遇到次数最多并包括第一个空间容器的容器。如果没有遇到空间容器,但是给定网络元素存在非空间容器,则所有非空间容器都将包含在结果中。仅当 Include Containers 设置为 enabled 时,此参数才适用。
| Boolean |
result_types [result_types,...] (可选) | 指定追踪返回的结果的类型。
| String |
allow_indeterminate_flow (可选) | 指定是否追踪具有不确定流向的要素。此参数仅在运行上溯追踪或下溯追踪时使用。
| Boolean |
validate_locatability (可选) | 指定当遇到非空间交汇点或边对象在遍历要素的关联层次结构中没有关联的容器或结构时,是否返回错误。此选项可确保追踪返回的非空间对象与空间要素关联。
| Boolean |
派生输出
名称 | 说明 | 数据类型 |
out_utility_network | 更新的公共设施网络。 | 公共设施网络 |
代码示例
以下 Python 窗口脚本演示了如何使用 AddTraceConfiguration 工具。
import arcpy
arcpy.AddTraceConfiguration_un(
r"SampleUNService\Elec Utility Network", "Upstream_RMT002", "UPSTREAM",
"Upstream trace on RMT002", "Upstream;RMT002", "ElectricDistribution",
"Medium Voltage", '', '', '', "EXCLUDE_CONTAINERS", "EXCLUDE_CONTENT",
"EXCLUDE_STRUCTURES", "INCLUDE_BARRIERS", "VALIDATE_CONSISTENCY", None,
None, "BOTH_JUNCTIONS_AND_EDGES", None, None, "BOTH_JUNCTIONS_AND_EDGES",
'', "DO_NOT_FILTER", None, '', None, None, None, None, None, None,
"EXCLUDE_ISOLATED_FEATURES", "DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS",
"DO_NOT_INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER", None,
"TRACE_INDETERMINATE_FLOW", "DO_NOT_VALIDATE_LOCATABILITY")
环境
许可信息
- Basic: 否
- Standard: 是
- Advanced: 是