追踪 (公共设施网络)

摘要

可根据指定起点的连通性或可遍历性返回公共设施网络的网络要素。

您可通过公共设施网络追踪功能分析网络中的路径。 可遍历性是指通过已连接或已关联的要素建立的路径,同时满足配置要求。

默认情况下,追踪结果将作为选择返回,并包含整个线要素。 要返回尊重沿起点障碍位置的部分要素结果,请将结果类型参数设置为聚合几何。 当边对象是使用合成几何参数的线要素的内容时,沿着边对象放置中跨的追踪位置可用于返回部分几何。

使用聚合几何选项,沿边放置的起点将从具有中跨连通性或端点的上一个交汇点返回边元素。 如果在选中包括障碍要素参数的情况下沿边放置障碍,追踪将在遇到中跨连通性的下一个交汇点或线终点处停止。 如果未选中包括障碍要素参数,则追踪将在遇到中跨连通性的上一个交汇点或上一个线终点处停止。

然后,可以将追踪生成的结果选择集或输出要素类传播到另一个地图或网络的逻辑示意图,或者将其用作另一个工具或追踪的输入。

了解有关追踪公共设施网络的详细信息

使用情况

  • 必须启用网络拓扑。 由于追踪工具依赖于网络拓扑,如果对脏区进行追踪,则追踪的结果可能不精确。 待追踪区域的网络拓扑必须经过验证以反映对网络进行的最近编辑或更新。

  • 使用企业级地理数据库时,输入公用设施网络必须是公共设施网络服务。

  • 通过 Python 使用追踪工具运行基于子网的追踪时,不会自动应用输入层的子网追踪配置,必须手动进行指定。

  • 对于过滤器障碍、过滤器函数障碍、函数和输出条件,当使用分配给日期字段的网络属性时,日期值应采用格式 yyyy-mm-dd hh:mm:ss,例如,2020-10-12 18:45:31

参数

标注说明数据类型
输入公共设施网络

将运行追踪的公共设施网络。 使用企业级地理数据库时,输入公共设施网络必须来自要素服务;不支持来自数据库连接的公共设施网络。

Utility Network; Utility Network Layer
追踪类型

指定将使用的追踪类型。

  • 已连接将使用从一个或多个起点开始并沿着已连接要素向外跨越的已连接追踪。 这是默认设置。
  • 子网将使用子网追踪,其从一个或多个起点开始向外跨越,目的是涵盖子网的范围。
  • 子网控制器将使用能够定位与子网关联的子网控制器上的源和汇的子网控制器追踪
  • 上游将使用能够发现网络中某位置上游的要素的上溯追踪
  • 下游将使用能够发现网络中某位置下游的要素的下溯追踪
  • 循环将使用能够从基于连通性的起点向外跨越的循环追踪。 循环是流向不明确的网络区域。
  • 最短路径将使用能够识别两个起点之间的最短路径的最短路径追踪
  • 孤立将使用能够发现孤立网络区域的要素的孤立追踪
String
起点
(可选)

使用追踪位置窗格中的起点工具创建的要素图层,或包含一个或多个表示追踪起点的记录的表或要素类。 该要素类或表必须包含 FEATUREGLOBALID 字段,用于存储来自关联网络要素的信息。 默认情况下,会使用工程默认地理数据库中的 UN_Temp_Starting_Points 要素类。

Feature Layer; Table View
障碍
(可选)

使用追踪位置窗格中的障碍工具创建的要素图层,或包含一个或多个表示防止追踪遍历超出此点的障碍的记录的表或要素类。 该要素类或表必须包含 FEATUREGLOBALID 字段,用于存储来自关联网络要素的信息。 默认情况下,会使用工程默认地理数据库中的 UN_Temp_Barriers 要素类。

Feature Layer; Table View
域网络
(可选)

将运行追踪的域网络的名称。 运行子网、子网控制器、上溯和下溯追踪类型时,需要此参数。

String
(可选)

追踪将开始的层的名称。 运行子网、子网控制器、上溯和下溯追踪类型时,需要此参数。

String
目标层
(可选)

输入层将流向的目标层的名称。 如果上溯和下溯追踪的此参数丢失,当到达起始子网边界时,上述追踪将停止。 该参数可以使此类追踪在层级结构中继续向上或向下延伸。

String
子网名称
(可选)

将运行追踪的子网的名称。 运行子网追踪类型时可以使用此参数。 如果指定了子网名称,则不需要起点参数。 当子网表包含层级的 10,000 条或更多记录时,不会填充参数的选择列表,并且会为子网名称提供一个空字段。

String
最短路径网络属性名称
(可选)

将用于计算最短路径的网络属性。 运行最短路径追踪类型时,使用数字网络属性(例如形状长度)计算最短路径。 基于成本和距离的路径都可以进行计算。 运行最短路径追踪时,需要此参数。

String
包括容器
(可选)

指定追踪结果中是否包含容器要素。

  • 选中 - 追踪结果中将包含容器要素。 由此将启用最多包含第一个空间容器参数。
  • 未选中 - 追踪结果中将不包含容器要素。 这是默认设置。

Boolean
包括内容
(可选)

指定追踪是否将在结果中返回容器要素的内容。

  • 选中 - 追踪结果将包含容器要素中的内容。
  • 未选中 - 追踪结果将不包含容器要素中的内容。 这是默认设置。

Boolean
包括结构
(可选)

指定追踪结果中是否包含结构要素和对象。

  • 选中 - 追踪结果中将包含结构要素和对象。
  • 未选中 - 追踪结果中将不包含结构要素和对象。 这是默认设置。

Boolean
包括障碍要素
(可选)

指定追踪结果中是否包含可遍历性障碍要素。 即使已在子网定义中进行了预设,可遍历性障碍仍可选。 此参数不适用于具备终端的设备要素。

  • 选中 - 追踪结果中将包含可遍历性障碍要素。 这是默认设置。
  • 未选中 - 追踪结果中将不包含可遍历性障碍要素。

Boolean
验证一致性
(可选)

指定如果在任何遍历的要素中遇到脏区是否返回错误。 这是保证追踪通过网络中状态一致要素的唯一方法。 要移除脏区,请验证网络拓扑。

  • 选中 - 如果在任何遍历的要素中遇到脏区,追踪将返回错误。 这是默认设置。
  • 未选中 - 无论是否在遍历的要素中遇到脏区,追踪都将返回结果。

Boolean
条件障碍
(可选)

基于与网络属性的比较或对类别字符串的检查,对要素设置可遍历性障碍条件。 条件障碍使用网络属性、运算符和类型以及属性值。 例如,当要素的 Device Status 属性等于 Open 的特定值时,将停止追踪。 当要素满足此条件时,追踪将停止。 如果您要使用多个属性,可使用 Combine Using 参数来定义 And 或 Or 条件。

条件障碍组件如下:

  • 名称 - 按系统中定义的任何网络属性或网络类别进行过滤。
  • 运算符 - 从大量运算符中进行选择。
  • 类型 - 从名称参数指定的值中选择特定值或网络属性。
  • - 提供会基于运算符值导致终止的输入属性类型的特定值。
  • Combine using - 如果要添加多个属性,则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。

条件障碍运算符值选项如下:

  • Is equal to - 该属性等于该值。
  • Does not equal - 该属性不等于该值。
  • Is greater than - 该属性大于该值。
  • Is greater than or equal to - 该属性大于或等于该值。
  • Is less than - 该属性小于该值。
  • Is less than or equal to - 该属性小于或等于该值。
  • Includes the values - 值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • Does not include the values - 值中的所有位并非都存在于属性中的“按位与”运算(按位与 != 值)。
  • Includes any - 值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • Does not include any - 值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

条件障碍类型值选项如下:

  • 特定值 - 按特定值过滤。
  • 网络属性 - 按网络属性过滤。

Value Table
函数障碍
(可选)

基于函数对要素设置可遍历性障碍。 函数障碍可用于执行以下操作:限制追踪距离起点的行程或设置停止追踪的最大值。 例如,所经过的每条线的长度和为目前经过的总距离。 当经过的总长度达到指定值时,追踪将停止。

函数障碍组件如下:

  • 函数 - 从大量计算函数中进行选择。
  • 属性 - 按系统中定义的任何网络属性进行过滤。
  • 运算符 - 从大量运算符中进行选择。
  • - 提供将导致终止的输入属性类型(若发现)的特定值。
  • 使用局部值 - 计算每个方向的值,而不是整体全局值,例如计算 Shape length 总和的函数障碍,其中,如果值大于或等于 4,则追踪终止。 在全局情况下,遍历两条值为 2 的边之后,Shape length 总和即已达到 4,因此追踪会停止。 如果使用局部值,每条路径上的局部值会变化,因此追踪会持续得更远。
    • 选中 - 将使用局部值。
    • 未选中 - 将使用全局值。 这是默认设置。

函数障碍函数值选项如下:

  • Minimum - 输入值的最小值。
  • Maximum - 输入值的最大值。
  • Add - 输入值的总和。
  • Average - 输入值的平均值。
  • Count - 要素数目。
  • Subtract - 输入值之间的差值。

    子网控制器和循环追踪类型不支持减法函数。

例如,起点要素的值为 20。 下一个要素的值为 30。 如果使用 Minimum 函数,则结果为 20;使用 Maximum 函数,结果为 30;使用 Add 函数,结果为 50;使用 Average 函数,结果为 25;使用 Count 函数,结果为 2;使用 Subtract 函数,结果为 -10。

函数障碍运算符值选项如下:

  • Is equal to - 该属性等于该值。
  • Does not equal - 该属性不等于该值。
  • Is greater than - 该属性大于该值。
  • Is greater than or equal to - 该属性大于或等于该值。
  • Is less than - 该属性小于该值。
  • Is less than or equal to - 该属性小于或等于该值。
  • Includes the values - 值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • Does not include the values - 值中的所有位并非都存在于属性中的“按位与”运算(按位与 != 值)。
  • Includes any - 值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • Does not include any - 值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

Value Table
应用可遍历性至
(可选)

指定将应用的可遍历性类型。 可遍历性范围用于确定是否在交汇点和/或边处应用可遍历性。 例如,如果定义了用于停止追踪的条件障碍,其中 Device Status 等于 Open 并将遍历范围仅设置为边,则即使追踪遇到开路设备,追踪也不会停止,因为 Device Status 仅适用于交汇点。 换言之,此参数会向追踪指出是否要忽略交汇点、边或这两者。

  • 交汇点和边可遍历性将同时应用于交汇点和边。 这是默认设置。
  • 仅交汇点可遍历性将仅应用于交汇点。
  • 仅边可遍历性将仅应用于边。
String
过滤器障碍
(可选)

用于设置针对特定类别或网络属性的追踪停止时间。 例如,针对生命周期状态属性等于特定值的要素,追踪停止。 此参数用于根据系统中定义的网络属性值设置终止符。 如果要使用多个属性,可使用组合方法选项来定义 And 或 Or 条件。

过滤器障碍组件如下:

  • 名称 - 按类别或系统中定义的任何网络属性进行过滤。
  • 运算符 - 从大量运算符中进行选择。
  • 类型 - 从名称参数中指定的值中选择特定值或网络属性。
  • - 提供会基于运算符值导致终止的输入属性类型的特定值。
  • 组合方法 - 如果要添加多个属性,则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。

过滤器障碍运算符值选项如下:

  • Is equal to - 该属性等于该值。
  • Does not equal - 该属性不等于该值。
  • Is greater than - 该属性大于该值。
  • Is greater than or equal to - 该属性大于或等于该值。
  • Is less than - 该属性小于该值。
  • Is less than or equal to - 该属性小于或等于该值。
  • Includes the values - 值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • Does not include the values - 值中的所有位并非都存在于属性中的“按位与”运算(按位与 != 值)。
  • Includes any - 值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • Does not include any - 值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

过滤器障碍类型值选项如下:

  • 特定值 - 按特定值过滤。
  • 网络属性 - 按网络属性过滤。

Value Table
过滤器函数障碍
(可选)

用于过滤特定类别的追踪结果。

过滤器函数障碍组件如下:

  • 函数 - 从大量计算函数中进行选择。
  • 属性 - 按系统中定义的任何网络属性进行过滤。
  • 运算符 - 从大量运算符中进行选择。
  • - 提供将导致终止的输入属性类型(若发现)的特定值。
  • 使用局部值 - 计算每个方向的值,而不是整体全局值。 例如计算形状长度总和的函数障碍,其中,如果值大于或等于 4,则追踪终止。 在全局情况下,遍历两条值为 2 的边之后,形状长度总和即已达到 4,因此追踪会停止。 如果使用本地值,每条路径上的本地值会变化,否则追踪将继续。
    • 选中 - 将使用局部值。 这是默认设置。
    • 未选中 - 将使用全局值。

过滤器函数障碍函数值选项如下:

  • 最小值 - 将识别输入值的最小值。
  • 最大值 - 将识别输入值的最大值。
  • 相加 - 将计算各值的总和。
  • 平均 - 将计算输入值的平均值。
  • 计数 - 将识别要素数。
  • - 将计算各值之间的差值。 子网控制器和循环追踪类型不支持减函数。

例如,起点要素的值为 20。 下一个要素的值为 30。 如果使用 Minimum 函数,则结果为 20。 使用 Maximum 函数,结果为 30;使用 Add 函数,结果为 50;使用 Average 函数,结果为 25;使用 Count 函数,结果为 2;使用 Subtract 函数,结果为 -10。

过滤器函数障碍运算符值选项如下:

  • 等于 - 该属性等于该值。
  • 不等于 - 该属性不等于该值。
  • 大于 - 该属性大于该值。
  • 大于或等于 - 该属性大于或等于该值。
  • 小于 - 该属性小于该值。
  • 小于或等于 - 该属性小于或等于该值。
  • Includes the values - 值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • Does not include the values - 值中的所有位并非都存在于属性中的“按位与”运算(按位与 != 值)。
  • Includes any - 值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • Does not include any - 值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

Value Table
将过滤器应用于
(可选)

指定是否在交汇点、边或这两处应用特定类别的过滤器。 例如,如果定义了用于停止追踪的过滤器障碍,其中 Device Status 等于 Open 并将遍历范围仅设置为边,则即使追踪遇到开路设备,追踪也不会停止,因为 Device Status 仅适用于交汇点。 换言之,此参数会向追踪指出是否要忽略交汇点、边或这两者。

  • 交汇点和边 - 过滤器将同时应用于交汇点和边。 这是默认设置。
  • 仅交汇点 - 过滤器将仅应用于交汇点。
  • 仅边 - 过滤器将仅应用于边。

  • 交汇点和边过滤器将同时应用于交汇点和边。 这是默认设置。
  • 仅交汇点过滤器将仅应用于交汇点。
  • 仅边过滤器将仅应用于边。
String
按 bitset 网络属性过滤
(可选)

将用于按 bitset 过滤的网络属性的名称。 此参数仅适用于上溯、下溯和循环追踪类型。 此参数可用于在追踪过程中添加特殊逻辑,以便追踪能够更好地反映真实世界的场景。 例如,对于循环追踪而言,Phases current 网络属性可以确定该循环是否为实际的电气循环(相同的相在循环 A 中各处均有电流通过),并且追踪结果只返回实际的电气循环。 上溯追踪的示例如下;如果追踪配电网络时指定 Phases current 网络属性,则追踪结果将只包含在网络属性中指定的有效路径,而不是所有路径。

String
按最近过滤
(可选)

指定是否使用 k-最近邻算法在给定距离内返回一些特定类型的要素。 可以提供计数、成本以及类别和/或资产类型的集合。

  • 选中 - 将使用 k-最近邻算法来返回计数成本网络属性最近类别最近资产组/类型参数中指定的一定数量的要素。
  • 未选中 - k 最近邻算法不会用于过滤结果。 这是默认设置。

Boolean
计数
(可选)

按最近过滤为选中状态时要返回的要素数量。

Long
成本网络属性
(可选)

按最近过滤为选中状态时,将用于计算接近度、成本或距离的数字网络属性(例如形状长度)。

String
最近类别
(可选)

按最近过滤处于选中状态时,将返回的类别(例如保护类别)。

String
最近资产组/类型
(可选)

按最近过滤处于选中状态时,将返回的资产组和资产类型(例如,ElectricDistributionDevice/Transformer/Step Down)。

String
函数
(可选)

将应用于追踪结果的计算函数。

函数组件如下:

  • 函数 - 从大量计算函数中进行选择。
  • 属性 - 按系统中定义的任何网络属性进行过滤。
  • 过滤器名称 - 按属性名称过滤函数结果。
  • 过滤器运算符 - 从大量运算符中进行选择。
  • 过滤器类型 - 从大量过滤类型中进行选择。
  • 过滤器值 - 提供输入过滤属性的特定值。

函数 Function 值选项如下:

  • 平均 - 将计算输入值的平均值。
  • 计数 - 将识别要素数。
  • 最大值 - 将识别输入值的最大值。
  • 最小值 - 将识别输入值的最小值。
  • 相加 - 将计算输入值的总和。
  • 相减 - 将计算输入值之间的差值。

    子网控制器和循环追踪类型不支持减函数。

例如,起点要素的值为 20。 下一个要素的值为 30。 如果使用 Minimum 函数,则结果为 20。 使用 Maximum 函数,结果为 30;使用 Add 函数,结果为 50;使用 Average 函数,结果为 25;使用 Count 函数,结果为 2;使用 Subtract 函数,结果为 -10。

函数过滤器运算符值选项如下:

  • 等于 - 该属性等于该值。
  • 不等于 - 该属性不等于该值。
  • 大于 - 该属性大于该值。
  • 大于或等于 - 该属性大于或等于该值。
  • 小于 - 该属性小于该值。
  • 小于或等于 - 该属性小于或等于该值。
  • Includes the values - 值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • Does not include the values - 值中的所有位并非都存在于属性中的“按位与”运算(按位与 != 值)。
  • Includes any - 值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • Does not include any - 值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

函数过滤器类型值选项如下:

  • 特定值 - 按特定值过滤。
  • 网络属性 - 按网络属性过滤。

  • 平均值将计算输入值的平均值。
  • 计数将识别要素数量。
  • 最大值将识别输入值的最大值。
  • 最小值将识别输入值的最小值。
  • 将计算各值的总和。
  • 将计算各值之间的差值。子网控制器和循环追踪类型不支持减函数。
Value Table
传播程序
(可选)

指定要传播的网络属性以及传播将在追踪过程中的发生方式。 传播的类属性表示子网控制器上已传播至子网余下要素的关键值。 例如,在配电模型中,您可传播相位值。

传播程序组件如下:

  • Attribute - 选择按系统中定义的任何网络属性进行过滤。
  • Substitution Attribute - 使用替换值而不是 bitset 网络属性值。 替换是基于正在传播的网络属性中的位数进行编码的。 替换是指同相位的某个位到另一个位的映射。 例如对于相 AC 而言,可通过一个替换将位 A 映射到 B,将位 C 映射到 null。 在该示例中,1010(相 AC)的替换是 0000-0010-0000-0000 (512)。 该替换将捕捉映射,以通知您相 A 被映射到 B,且相 C 被映射到 null 而非相反(即相 A 未映射到 null,且相 C 未映射到 B)。
  • Function - 从大量计算函数中进行选择。
  • Operator - 从大量运算符中进行选择。
  • Value - 提供会基于运算符值导致终止的输入属性类型的特定值。

传播程序 Function 值选项如下:

传播程序 Operator 值选项如下:

了解有关按位运算符的详细信息

  • 等于属性与值相等。
  • 不等于属性与值不相等。
  • 大于属性大于值。
  • 大于或等于属性大于或等于值。
  • 小于属性小于值。
  • 小于或等于属性小于或等于值。
  • 包括值(按位与等于值)值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • 不包括值(按位与不等于值)并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • 包括任何值(按位与等于 True)值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • 不包括任何值(按位与等于 False)值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。
注:

此参数仅可用于 Python

Value Table
输出资产类型
(可选)

过滤要包含在结果中的输出资产类型 - 例如,仅返回架空变压器。

String
输出条件
(可选)

按网络属性或类别返回的要素类型。 例如,如果将追踪配置为“过滤掉除水龙头要素外的所有要素”,那么未分配水龙头类别的追踪要素均不会包含在结果中。 任何追踪的要素都会返回到结果选择集中。

输出条件组件如下:

  • 名称 - 按系统中定义的任何网络属性进行过滤。
  • 运算符 - 从大量运算符中进行选择。
  • 类型 - 从名称参数中指定的值中选择特定值或网络属性。
  • - 提供会基于运算符值导致终止的输入属性类型的特定值。
  • 组合方法 - 如果要添加多个属性,则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。

输出条件运算符值选项如下:

  • 等于 - 该属性等于该值。
  • 不等于 - 该属性不等于该值。
  • 大于 - 该属性大于该值。
  • 大于或等于 - 该属性大于或等于该值。
  • 小于 - 该属性小于该值。
  • 小于或等于 - 该属性小于或等于该值。
  • Includes the values - 值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • Does not include the values - 值中的所有位并非都存在于属性中的“按位与”运算(按位与 != 值)。
  • Includes any - 值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • Does not include any - 值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

输出条件类型值选项如下:

  • 特定值 - 按特定值过滤。
  • 网络属性 - 按网络属性过滤。

Value Table
包括孤立要素
(可选)

指定追踪结果中是否包含孤立要素。 此参数仅在运行孤立追踪时使用。

  • 选中 - 追踪结果中将包含孤立要素。
  • 未选中 - 追踪结果中将不包含孤立要素。 这是默认设置。

Boolean
忽略起点处障碍
(可选)

指定是否在追踪配置中忽略起点处的动态障碍。 这在执行上游保护设备追踪并使用所发现的保护设备(屏障)作为起始点以找到后续上游保护设备时可能非常有用。

  • 选中 - 追踪过程中将忽略起点处的障碍。
  • 未选中 - 追踪过程中不会忽略起点处的障碍。 这是默认设置。

Boolean
最多包含第一个空间容器
(可选)

指定是否将已返回的容器限制为仅在追踪结果中包含那些所遇到的容器,且最多包含每个网络元素的第一个空间容器。 如果没有遇到空间容器,但是存在给定网络元素的非空间容器,则所有非空间容器都将包含在结果中。 仅当选中包含容器时,此参数才可用。

  • 选中 - 当沿追踪路径遇到嵌套包含关联时,结果中仅返回遇到次数最多并包括第一个空间容器的容器。 如果不存在空间容器,则给定网络元素的所有非空间容器都将包含在结果中。
  • 未选中 - 所有容器都将在结果中返回。 这是默认设置。
Boolean
结果类型
(可选)

指定追踪返回的结果的类型。

  • 选择追踪结果将作为相应网络要素上的选择集返回。 这是默认设置。
  • 聚合几何追踪结果按几何类型聚合,并存储在活动地图的图层中显示的多部件要素类中。
  • 连通性追踪结果将作为已遍历网络要素的指定输出 .json 文件中的连通图返回。 此选项将启用输出 JSON 参数。
  • 元素追踪结果将作为遍历网络要素的指定输出 .json 文件中的基于要素的信息返回。 此选项将启用输出 JSON 参数。
  • 要素追踪结果将作为遍历网络要素的指定输出 .json 文件中的基于要素的信息返回。 此选项可以启用包括几何包括域描述结果网络属性结果字段输出 JSON 参数。
  • 包含和附件关联追踪结果将作为遍历网络要素的关联信息返回,这些网络要素通过指定输出 .json 文件中的包含和结构附件关联进行关联。 此选项可以启用包含域描述输出 JSON 参数。
String
选择内容类型

指定如何应用所选内容以及如果已存在当前内容要执行的操作。

  • 新建选择内容生成的选择内容将替换当前选择内容。 这是默认设置。
  • 添加到当前选择内容当存在一个选择内容时,会将生成的选择内容添加到当前选择内容中。 如果不存在选择内容,该选项的作用与新选择内容选项的作用相同。
  • 从当前选择内容中移除将生成的选择内容从当前选择内容中移除。 如果不存在选择内容,该选项不起作用。
  • 选择当前选择内容的子集将生成的选择内容与当前选择内容进行组合。 仅两者共有的记录保持选中状态。
  • 切换当前选择内容生成的选择内容将被切换。 将所选的结果从当前选择内容中移除,同时将未选取的结果添加到当前选择内容中。 如果不存在选择内容,该选项的作用与新选择内容选项的作用相同。
String
清除所有之前的追踪结果
(可选)

指定是将内容从选择用于存储聚合几何的要素类截断还是追加到其上。 此参数仅适用于聚合几何结果类型。

  • 选中 - 将截断用于存储聚合追踪几何的要素类。 将仅写入当前追踪操作的输出几何。 这是默认设置。
  • 未选中 - 当前追踪操作的输出几何将追加到用于存储聚合几何的要素类。
Boolean
追踪名称
(可选)

追踪操作的名称。 此值将存储在输出要素类的 TRACENAME 字段中,以协助识别追踪结果。 此参数仅适用于聚合几何结果类型。

String
聚合的点
(可选)

包含聚合结果几何的输出多点要素类。 默认情况下,将使用名为 Trace_Results_Aggregated_Points 的系统生成要素类填充该参数,该要素类将存储在工程的默认地理数据库中。

如果该要素类不存在,则系统会自动创建。 也可以使用现有要素类存储聚合几何。 如果使用非默认要素类,则该要素类必须是多点要素类,并且包含名为 TRACENAME 的字符串字段。 此参数仅适用于聚合几何结果类型。

Feature Class
聚合线
(可选)

包含聚合结果几何的输出折线要素类。 默认情况下,将使用名为 Trace_Results_Aggregated_Lines 的系统生成要素类填充该参数,该要素类将存储在工程的默认地理数据库中。

如果该要素类不存在,则系统会自动创建。 也可以使用现有要素类存储聚合几何。 如果使用非默认要素类,则该要素类必须是折线要素类,并且包含名为 TRACENAME 的字符串字段。 此参数仅适用于聚合几何结果类型。

Feature Class
聚合面
(可选)

包含聚合结果几何的输出面要素类。 默认情况下,将使用名为 Trace_Results_Aggregated_Polygons 的系统生成要素类填充该参数,该要素类将存储在工程的默认地理数据库中。

如果该要素类不存在,则系统会自动创建。 也可以使用现有要素类存储聚合几何。 如果使用非默认要素类,则该要素类必须是面要素类,并且包含名为 TRACENAME 的字符串字段。 此参数仅适用于聚合几何结果类型。

Feature Class
允许不确定的流
(可选)

指定是否追踪具有不确定流向的要素。 仅在运行上溯追踪、下溯追踪或孤立追踪时应用此参数。

  • 选中 - 将追踪具有不确定流向的要素。 这是默认设置。
  • 未选中 - 具有不确定流向的要素将停止可遍历性并且不会被追踪。

注:

此参数需要公共设施网络版本值为 5 或更高。

Boolean
验证可定位性
(可选)

指定如果遇到非空间交汇点或边对象并且遍历对象的关联层次结构中没有必要的包含、附件或连通性关联,是否在追踪操作期间返回错误。 此参数确保可以通过与要素或其他可定位对象的关联来定位追踪或更新子网操作返回的非空间对象。

  • 选中 - 如果遇到非空间交汇点或边对象并且遍历对象的关联层次结构中没有必要的包含、附件或连通性关联,则追踪将返回一条错误。
  • 未选中 - 追踪不会检查是否存在无法定位的对象并返回结果,无论遍历对象的关联层次结构中是否存在无法定位的对象。 这是默认设置。

注:

此参数需要公共设施网络版本值为 4 或更高。

Boolean
使用追踪配置
(可选)

指定是否将使用现有指定追踪配置来填充此工具的参数。

  • 选中 - 将使用现有指定追踪配置来定义追踪的属性。 将忽略除追踪配置名称起点障碍之外的所有参数。
  • 未选中 - 不使用现有指定追踪配置来定义追踪的属性。 这是默认设置。

注:

此参数需要公共设施网络版本值为 5 或更高。

Boolean
追踪配置名称
(可选)

将用于定义追踪属性的现有指定追踪配置的名称。 仅当选中使用追踪配置参数时,此参数才会处于活动状态。

注:

此参数需要公共设施网络版本值为 5 或更高。

String
输出 JSON
(可选)

使用连通性、元素、要素或包含和附件关联结果类型返回追踪结果时将生成的 .json 文件的名称和位置。

File
在服务器上以异步模式运行
(可选)

指定在使用企业级地理数据库中的公共设施网络时是否异步处理追踪操作。

  • 选中 - 将异步处理追踪操作。
  • 未选中 - 将同步处理追踪操作。 这是默认设置。

注:

此参数需要 ArcGIS Enterprise 10.9.1 或更高版本。

Boolean
包括几何
(可选)

指定是否在结果中包括几何。

  • 选中 - 结果中将包含几何。
  • 未选中 - 结果中将不包含几何。 这是默认设置。

注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

Boolean
包括域描述
(可选)

指定域描述是否将包含在输出 .json 文件中以传达控制器、要素元素、连通性和关联的域映射。

  • 选中 - 将在结果中包含域描述。
  • 未选中 - 不会在结果中包含域描述。 这是默认设置。

注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

Boolean
结果网络属性
(可选)

将包含在结果中的网络属性。

注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

String
结果字段
(可选)

要素类中将作为结果返回的字段。 该字段的值将在追踪要素的结果中返回。

注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

Value Table
使用数字化方向
(可选)

指定上游和下游追踪操作是否将使用线的数字化方向、关联中边缘对象的“起始”和“终止”全局 ID 以及 Flow direction 属性来确定流向。 当追踪类型参数设置为上游下游时,此参数仅适用于 Utility Network 版本 7 及更高版本。

  • 选中 - 追踪操作将使用线的数字化方向、关联中边对象的“起始”和“结束”全局 ID 以及流向属性来确定流向。 选中此项后,域网络目标层参数将被隐藏并忽略。
  • 未选中 - 跟踪操作将根据子网控制器的位置确定流向。 这是默认设置。

注:

使用企业级地理数据库时,此参数需要 ArcGIS Enterprise 11.3 或更高版本。

Boolean
合成几何
(可选)

指定是否为作为跟踪操作的一部分遍历的关联和边缘对象推断和创建(合成)几何。 此参数仅适用于聚合几何结果类型。

  • 选中 - 将为输出 Trace_Results_Aggreerated_Lines 要素类中遍历的关联和边对象推断并创建几何。
  • 未选中 - 不会为遍历的关联和边对象合成几何。 这是默认设置。
Boolean

派生输出

标注说明数据类型
输出公共设施网络

更新的公共设施网络。

Utility Network

arcpy.un.Trace(in_utility_network, trace_type, {starting_points}, {barriers}, {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}, selection_type, {clear_all_previous_trace_results}, {trace_name}, {aggregated_points}, {aggregated_lines}, {aggregated_polygons}, {allow_indeterminate_flow}, {validate_locatability}, {use_trace_config}, {trace_config_name}, {out_json_file}, {run_async}, {include_geometry}, {include_domain_descriptions}, {result_network_attributes}, {result_fields}, {use_digitized_direction}, {synthesize_geometries})
名称说明数据类型
in_utility_network

将运行追踪的公共设施网络。 使用企业级地理数据库时,输入公共设施网络必须来自要素服务;不支持来自数据库连接的公共设施网络。

Utility Network; Utility Network Layer
trace_type

指定将使用的追踪类型。

  • CONNECTED将使用从一个或多个起点开始并沿着已连接要素向外跨越的已连接追踪。 这是默认设置。
  • SUBNETWORK将使用子网追踪,其从一个或多个起点开始向外跨越,目的是涵盖子网的范围。
  • SUBNETWORK_CONTROLLERS将使用能够定位与子网关联的子网控制器上的源和汇的子网控制器追踪
  • UPSTREAM将使用能够发现网络中某位置上游的要素的上溯追踪
  • DOWNSTREAM将使用能够发现网络中某位置下游的要素的下溯追踪
  • LOOPS将使用能够从基于连通性的起点向外跨越的循环追踪。 循环是流向不明确的网络区域。
  • SHORTEST_PATH将使用能够识别两个起点之间的最短路径的最短路径追踪
  • ISOLATION将使用能够发现孤立网络区域的要素的孤立追踪
String
starting_points
(可选)

表或要素类,其中包含一个或多个表示追踪起点的记录。 该要素类或表必须包含 FEATUREGLOBALID 字段,用于存储来自关联网络要素的信息。 要查看特定格式,请使用追踪位置窗格中的起点工具创建起点,并查看默认地理数据库中存储的 UN_Temp_Starting_Points 要素类的方案。

Feature Layer; Table View
barriers
(可选)

包含一个或多个要素,表示防止追踪遍历超出此点的追踪障碍的表或要素类。 该要素类或表必须包含 FEATUREGLOBALID 字段,用于存储来自关联网络要素的信息。 要查看特定格式,请使用追踪位置窗格中的障碍工具创建障碍,并查看默认地理数据库中存储的 UN_Temp_Barriers 要素类的方案。

Feature Layer; Table View
domain_network
(可选)

将运行追踪的域网络的名称。 运行子网、子网控制器、上溯和下溯追踪类型时,需要此参数。

String
tier
(可选)

追踪将开始的层的名称。 运行子网、子网控制器、上溯和下溯追踪类型时,需要此参数。

String
target_tier
(可选)

输入层将流向的目标层的名称。 如果上溯和下溯追踪的此参数丢失,当到达起始子网边界时,上述追踪将停止。 该参数可以使此类追踪在层级结构中继续向上或向下延伸。

String
subnetwork_name
(可选)

将运行追踪的子网的名称。 运行子网追踪类型时可以使用此参数。 如果指定了子网名称,则不需要 starting_points 参数。

String
shortest_path_network_attribute_name
(可选)

将用于计算最短路径的网络属性。 运行最短路径追踪类型时,使用数字网络属性(例如形状长度)计算最短路径。 基于成本和距离的路径都可以进行计算。 运行最短路径追踪时,需要此参数。

String
include_containers
(可选)

指定追踪结果中是否包含容器要素。

  • INCLUDE_CONTAINERS追踪结果中将包含容器要素。
  • EXCLUDE_CONTAINERS追踪结果中将不包含容器要素。 这是默认设置。
Boolean
include_content
(可选)

指定追踪是否将在结果中返回容器要素的内容。

  • INCLUDE_CONTENT追踪结果将包含容器要素中的内容。
  • EXCLUDE_CONTENT追踪结果将不包含容器要素中的内容。 这是默认设置。
Boolean
include_structures
(可选)

指定追踪结果中是否包含结构要素和对象。

  • INCLUDE_STRUCTURES追踪结果中将包含结构要素和对象。
  • EXCLUDE_STRUCTURES追踪结果中将不包含结构要素和对象。 这是默认设置。
Boolean
include_barriers
(可选)

指定追踪结果中是否包含可遍历性障碍要素。 即使已在子网定义中进行了预设,可遍历性障碍仍可选。 此参数不适用于具备终端的设备要素。

  • INCLUDE_BARRIERS追踪结果中将包含可遍历性障碍要素。 这是默认设置。
  • EXCLUDE_BARRIERS追踪结果中将不包含可遍历性障碍要素。
Boolean
validate_consistency
(可选)

指定如果在任何遍历的要素中遇到脏区是否返回错误。 这是保证追踪通过网络中状态一致要素的唯一方法。 要移除脏区,请验证网络拓扑。

  • VALIDATE_CONSISTENCY如果在任何遍历的要素中遇到脏区,追踪将返回错误。 这是默认设置。
  • DO_NOT_VALIDATE_CONSISTENCY无论是否在遍历的要素中遇到脏区,追踪都将返回结果。
Boolean
condition_barriers
[[Name, Operator, Type, Value, Combine Using],...]
(可选)

基于与网络属性的比较或对类别字符串的检查,对要素设置可遍历性障碍条件。 条件障碍使用网络属性、运算符和类型以及属性值。 例如,当要素的 Device Status 属性等于 Open 的特定值时,将停止追踪。 当要素满足此条件时,追踪将停止。 如果您要使用多个属性,可使用 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属性小于或等于值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INCLUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

条件障碍 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 - 计算每个方向上的值,而非总体全局值,例如,可以配置一个函数障碍,如果 Shape length 的总和大于或等于 4,则将停止追踪。 使用全局值,遍历任意两条值为 2 的边之后,Shape length 总和将达到 4,追踪即会停止。 如果使用局部值,则当遍历遇到分叉时,沿分支的每条路径的计算值将单独维护。 在这种情况下,如果起点位于分叉处,则将分别计算沿每条路径的局部值,并且将继续追踪,直到沿每条路径达到总和 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函数结果小于或等于该值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INCLUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

函数障碍 Use Local Values 选项如下:

  • TRUE将使用局部值。 这是默认设置。
  • FALSE将使用全局值。
Value Table
traversability_scope
(可选)

指定将应用的可遍历性类型。 可遍历性范围用于确定是否在交汇点和/或边处应用可遍历性。 例如,如果定义了用于停止追踪的条件障碍,其中 Device Status 等于 Open 并将遍历范围仅设置为边,则即使追踪遇到开路设备,追踪也不会停止,因为 Device Status 仅适用于交汇点。 换言之,此参数会向追踪指出是否要忽略交汇点、边或这两者。

  • BOTH_JUNCTIONS_AND_EDGES可遍历性将同时应用于交汇点和边。 这是默认设置。
  • JUNCTIONS_ONLY可遍历性将仅应用于交汇点。
  • EDGES_ONLY可遍历性将仅应用于边。
String
filter_barriers
[[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_OR_EQUAL_TO属性小于或等于值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INLCUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

过滤器障碍 Type 值选项如下:

  • SPECIFIC_VALUE按特定值过滤。
  • NETWORK_ATTRIBUTE按网络属性过滤。

过滤器障碍 Combine Using 值选项如下:

  • AND合并条件障碍。
  • OR满足任一条件障碍时使用。

了解有关使用多条件表达式的详细信息

Value Table
filter_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属性小于或等于值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INCLUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

过滤器函数障碍 Use Local Values 选项如下:

  • TRUE将使用局部值。 这是默认设置。
  • FALSE将使用全局值。
Value Table
filter_scope
(可选)

指定是否在交汇点、边或这两处应用特定类别的过滤器。 例如,如果定义了用于停止追踪的过滤器障碍,其中 Device Status 等于 Open 并将遍历范围仅设置为边,则即使追踪遇到开路设备,追踪也不会停止,因为 Device Status 仅适用于交汇点。 换言之,此参数会向追踪指出是否要忽略交汇点、边或这两者。

  • BOTH_JUNCTIONS_AND_EDGES过滤器将同时应用于交汇点和边。 这是默认设置。
  • JUNCTIONS_ONLY过滤器将仅应用于交汇点。
  • EDGES_ONLY过滤器将仅应用于边。
String
filter_bitset_network_attribute_name
(可选)

将用于按 bitset 过滤的网络属性的名称。 此参数仅适用于上溯、下溯和循环追踪类型。 此参数可用于在追踪过程中添加特殊逻辑,以便追踪能够更好地反映真实世界的场景。 例如,对于循环追踪而言,Phases current 网络属性可以确定该循环是否为实际的电气循环(相同的相在循环 A 中各处均有电流通过),并且追踪结果只返回实际的电气循环。 上溯追踪的示例如下;如果追踪配电网络时指定 Phases current 网络属性,则追踪结果将只包含在网络属性中指定的有效路径,而不是所有路径。

String
filter_nearest
(可选)

指定是否使用 k-最近邻算法在给定距离内返回一些特定类型的要素。 可以提供计数、成本以及类别和/或资产类型的集合。

  • FILTER_BY_NEAREST将使用 k-最近邻算法来返回 nearest_countnearest_cost_network_attributenearest_categoriesnearest_assets 参数中指定的一定数量的要素。
  • DO_NOT_FILTERk 最近邻算法不会用于过滤结果。 这是默认设置。
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 - 从大量计算函数中进行选择。
  • Attribute - 选择按系统中定义的任何网络属性进行过滤。
  • Filter Name - 按属性名称过滤函数结果。
  • Filter Operator - 从大量运算符中进行选择。
  • Filter Type - 从大量的过滤类型中进行选择。
  • Filter Value - 提供输入过滤属性的特定值。

函数 Function 值选项如下:

  • AVERAGE将计算输入值的平均值。
  • COUNT将识别要素数量。
  • MAX将识别输入值的最大值。
  • MIN将识别输入值的最小值。
  • ADD将计算各值的总和。
  • SUBTRACT将计算各值之间的差值。子网控制器和循环追踪类型不支持减函数。

例如,起点要素的值为 20。 下一个要素的值为 30。 如果您正在使用 MINIMUM 函数,则结果为 20;使用 MAXIMUM 函数,结果为 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_OR_EQUAL_TO属性小于或等于值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INCLUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

函数 Filter Type 值选项如下:

  • SPECIFIC_VALUE按特定值过滤。
  • NETWORK_ATTRIBUTE按网络属性过滤。
Value Table
propagators
[[Attribute, Substitution Attribute, Function, Operator, Value],...]
(可选)

指定要传播的网络属性以及传播将在追踪过程中的发生方式。 传播的类属性表示子网控制器上已传播至子网余下要素的关键值。 例如,在配电模型中,您可传播相位值。

传播程序组件如下:

  • Attribute - 选择按系统中定义的任何网络属性进行过滤。
  • Substitution Attribute - 使用替换值而不是 bitset 网络属性值。 替换是基于正在传播的网络属性中的位数进行编码的。 替换是指同相位的某个位到另一个位的映射。 例如对于相 AC 而言,可通过一个替换将位 A 映射到 B,将位 C 映射到 null。 在该示例中,1010(相 AC)的替换是 0000-0010-0000-0000 (512)。 该替换将捕捉映射,以通知您相 A 被映射到 B,且相 C 被映射到 null 而非相反(即相 A 未映射到 null,且相 C 未映射到 B)。
  • Function - 从大量计算函数中进行选择。
  • Operator - 从大量运算符中进行选择。
  • Value - 提供会基于运算符值导致终止的输入属性类型的特定值。

传播程序 Function 值选项如下:

  • PROPAGATED_BITWISE_AND将比较一个要素与下一个要素的值。
  • PROPAGATED_MIN将确定最小值。
  • PROPAGATED_MAX将确定最大值。

传播程序 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属性小于或等于值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INCLUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

注:

此参数仅可用于 Python

Value Table
output_assettypes
[output_assettypes,...]
(可选)

过滤要包含在结果中的输出资产类型 - 例如,仅返回架空变压器。

String
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_OR_EQUAL_TO属性小于或等于值。
  • INCLUDES_THE_VALUES值中的所有位都存在于属性中的“按位与”运算(按位与 == 值)。
  • DOES_NOT_INCLUDE_THE_VALUES并非值中的所有位都存在于属性中的“按位与”运算(按位与 != 值)。
  • INCLUDES_ANY值中至少有一位存在于属性中的“按位与”运算(按位与 == True)。
  • DOES_NOT_INCLUDE_ANY值中的所有位均未存在于属性中的“按位与”运算(按位与 == False)。

了解有关按位运算符的详细信息

输出条件 Type 值选项如下:

  • SPECIFIC_VALUE按特定值过滤。
  • NETWORK_ATTRIBUTE按网络属性过滤。

输出条件 Combine Using 值选项如下:

  • AND组合条件。
  • OR满足任一条件时使用。

了解有关使用多条件表达式的详细信息

Value Table
include_isolated_features
(可选)

指定追踪结果中是否包含孤立要素。 此参数仅在运行孤立追踪时使用。

  • INCLUDE_ISOLATED_FEATURES追踪结果中将包含孤立要素。
  • EXCLUDE_ISOLATED_FEATURES追踪结果中将不包含孤立要素。 这是默认设置。
注:

在使用企业级地理数据库时,孤立追踪类型需要 ArcGIS Enterprise 10.7 或更高版本。

Boolean
ignore_barriers_at_starting_points
(可选)

指定是否在追踪配置中忽略起点处的动态障碍。 这在执行上游保护设备追踪并使用所发现的保护设备(屏障)作为起始点以找到后续上游保护设备时可能非常有用。

  • IGNORE_BARRIERS_AT_STARTING_POINTS追踪过程中将忽略起点处的障碍。
  • DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS追踪过程中不会忽略起点处的障碍。 这是默认设置。
Boolean
include_up_to_first_spatial_container
(可选)

指定是否将已返回的容器限制为仅在追踪结果中包含那些所遇到的容器,且最多包含每个网络元素的第一个空间容器。 如果没有遇到空间容器,但是存在给定网络元素的非空间容器,则所有非空间容器都将包含在结果中。 仅当 include_containers 设置为 INCLUDE_CONTAINERS 时,此参数才适用。

  • INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER当沿追踪路径遇到嵌套包含关联时,结果中仅包含遇到次数最多并包括第一个空间容器的容器。 如果不存在空间容器,则给定网络元素的所有非空间容器都将包含在结果中。
  • DO_NOT_INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER所有容器都将在结果中返回。 这是默认设置。
Boolean
result_types
[result_types,...]
(可选)

指定追踪返回的结果的类型。

  • SELECTION追踪结果将作为相应网络要素上的选择集返回。 这是默认设置。
  • AGGREGATED_GEOMETRY追踪结果按几何类型聚合,并存储在活动地图的图层中显示的多部件要素类中。
  • CONNECTIVITY追踪结果将作为已遍历网络要素的指定输出 .json 文件中的连通图返回。 此选项将启用 out_json_file 参数。
  • ELEMENTS追踪结果将作为遍历网络要素的指定输出 .json 文件中的基于要素的信息返回。 此选项将启用 out_json_file 参数。
  • FEATURES追踪结果将作为遍历网络要素的指定输出 .json 文件中的基于要素的信息返回。 此选项将启用 include_geometryinclude_domain_descriptionresult_network_attributesresult_fieldsout_json_file 参数。
  • CONTAINMENT_AND_ATTACHMENT_ASSOCIATIONS追踪结果将作为遍历网络要素的关联信息返回,这些网络要素通过指定输出 .json 文件中的包含和结构附件关联进行关联。 此选项将启用 include_domain_descriptionout_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
aggregated_polygons
(可选)

包含聚合结果几何的输出面要素类。 默认情况下,将使用名为 Trace_Results_Aggregated_Polygons 的系统生成要素类填充该参数,该要素类将存储在工程的默认地理数据库中。

如果该要素类不存在,则系统会自动创建。 也可以使用现有要素类存储聚合几何。 如果使用非默认要素类,则该要素类必须是面要素类,并且包含名为 TRACENAME 的字符串字段。 此参数仅适用于聚合几何结果类型。

Feature Class
allow_indeterminate_flow
(可选)

指定是否追踪具有不确定流向的要素。 仅在运行上溯追踪、下溯追踪或孤立追踪时应用此参数。

  • TRACE_INDETERMINATE_FLOW将追踪具有不确定流向的要素。 这是默认设置。
  • IGNORE_INDETERMINATE_FLOW具有不确定流向的要素将停止可遍历性并且不会被追踪。
注:

此参数需要公共设施网络版本值为 5 或更高。

Boolean
validate_locatability
(可选)

指定如果遇到非空间交汇点或边对象并且遍历对象的关联层次结构中没有必要的包含、附件或连通性关联,是否在追踪操作期间返回错误。 此参数确保可以通过与要素或其他可定位对象的关联来定位追踪或更新子网操作返回的非空间对象。

  • VALIDATE_LOCATABILITY如果遇到非空间交汇点或边对象并且遍历对象的关联层次结构中没有必要的包含、附件或连通性关联,则追踪将返回一条错误。
  • DO_NOT_VALIDATE_LOCATABILITY追踪不会检查是否存在无法定位的对象并返回结果,无论遍历对象的关联层次结构中是否存在无法定位的对象。 这是默认设置。
注:

此参数需要公共设施网络版本值为 4 或更高。

Boolean
use_trace_config
(可选)

指定是否将使用现有指定追踪配置来填充此工具的参数。

  • USE_TRACE_CONFIGURATION将使用现有指定追踪配置来定义追踪的属性。 将忽略除 trace_config_namestarting_pointsbarriers 之外的所有参数。
  • DO_NOT_USE_TRACE_CONFIGURATION不使用现有指定追踪配置来定义追踪的属性。 这是默认设置。
注:

此参数需要公共设施网络版本值为 5 或更高。

Boolean
trace_config_name
(可选)

将用于定义追踪属性的现有指定追踪配置的名称。 仅当将 use_trace_config 参数设置为 USE_TRACE_CONFIGURATION 时,才会启用此参数。

String
out_json_file
(可选)

使用连通性、元素、要素或包含和附件关联结果类型返回追踪结果时将生成的 .json 文件的名称和位置。

File
run_async
(可选)

指定在使用企业级地理数据库中的公共设施网络时是否异步处理追踪操作。

  • RUN_ASYNCHRONOUSLY将异步处理追踪操作。
  • RUN_SYNCHRONOUSLY将同步处理追踪操作。 这是默认设置。
注:
此参数需要 ArcGIS Enterprise 10.9.1 或更高版本。
Boolean
include_geometry
(可选)

指定是否在结果中包括几何。

  • INCLUDE_GEOMETRY结果中将包含几何。
  • EXCLUDE_GEOMETRY结果中将不包含几何。 这是默认设置。
注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

Boolean
include_domain_descriptions
(可选)

指定域描述是否将包含在输出 .json 文件中以传达控制器、要素元素、连通性和关联的域映射。

  • INCLUDE_DOMAIN_DESCRIPTIONS将在结果中包含域描述。
  • EXCLUDE_DOMAIN_DESCRIPTIONS不会在结果中包含域描述。 这是默认设置。
注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

Boolean
result_network_attributes
[result_network_attributes,...]
(可选)

将包含在结果中的网络属性。

注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

String
result_fields
[[Feature Class, Field Name],...]
(可选)

要素类中将作为结果返回的字段。 该字段的值将在追踪要素的结果中返回。

注:

对于企业级地理数据库,此参数需要 ArcGIS Enterprise 11.1 或更高版本。

Value Table
use_digitized_direction
(可选)

指定上游和下游追踪操作是否将使用线的数字化方向、关联中边缘对象的“起始”和“终止”全局 ID 以及 Flow direction 属性来确定流向。 当 trace_type 参数设置为 UPSTREAMDOWNSTREAM 选项时,此参数仅适用于 Utility Network 版本 7 及更高版本。

  • USE_DIGITIZED_DIRECTION追踪操作将使用线的数字化方向、关联中边对象的“起始”和“结束”全局 ID 以及流向属性来确定流向。 使用此选项,domain_networktiertarget_tier 参数将被忽略。
  • IGNORE_DIGITIZED_DIRECTION跟踪操作将根据子网控制器的位置确定流向。 这是默认设置。
注:
使用企业级地理数据库时,此参数需要 ArcGIS Enterprise 11.3 或更高版本。
Boolean
synthesize_geometries
(可选)

指定是否为作为跟踪操作的一部分遍历的关联和边缘对象推断和创建(合成)几何。 此参数仅适用于聚合几何结果类型。

  • DO_NOT_SYNTHESIZE_GEOMETRIES不会为遍历的关联和边对象合成几何。 这是默认设置。
  • SYNTHESIZE_GEOMETRIES将为输出 Trace_Results_Aggreerated_Lines 要素类中遍历的关联和边对象推断并创建几何。

注:
使用企业级地理数据库时,此参数需要 ArcGIS Enterprise 11.3 或更高版本。

Boolean

派生输出

名称说明数据类型
out_utility_network

更新的公共设施网络。

Utility Network

代码示例

Trace 示例(独立脚本)

对配电网络运行下溯追踪,该配电网络位于在相位 A、B 和 C 上叠加变压器负载的中压层。

'''****************************************************************************
Name:        DownstreamTrace.py
Description: This script executes a downstream trace on the Medium Voltage tier 
             that adds up the transformer load on phases A, B, and C.
Created by:  Esri
****************************************************************************'''

# Import required modules        
import arcpy

# Set local variables
in_utility_network = "NapervilleElectric Utility Network"
trace_type = "DOWNSTREAM"
starting_points = "C:\\MyProject\\Bissell.gdb\UN_Temp_Starting_Points"
barriers = "C:\\MyProject\\Bissell.gdb\UN_Temp_Barriers"
domain_network = "ElectricDistribution"
tier = "Medium Voltage Radial"
include_containers = "INCLUDE_CONTAINERS"
include_content ="INCLUDE_CONTENT"
include_structures = "INCLUDE_STRUCTURES"
include_barriers ="INCLUDE_BARRIERS"
condition_barriers = "'Device Status' IS_EQUAL_TO SPECIFIC_VALUE 1 #"
propagators = "'Phases Current' phasessub PROPAGATED_BITWISE_AND INCLUDES_ANY 15"
functions = "ADD 'Transformer Load' 'Phases Normal' INCLUDES_THE_VALUES SPECIFIC_VALUE 4;ADD 'Transformer Load' 'Phases Normal' INCLUDES_THE_VALUES SPECIFIC_VALUE 2;ADD 'Transformer Load' 'Phases Normal' INCLUDES_THE_VALUES SPECIFIC_VALUE 1"
synthesize_geometries = "SYNTHESIZE_GEOMETRIES"

# Run Trace with specified parameters and leave the rest default
arcpy.un.Trace(in_utility_network, 
               trace_type, 
               starting_points, 
               barriers, 
               domain_network, 
               tier,
               include_containers=include_containers,
               include_content=include_content,
               include_structures=include_structures,
               condition_barriers=condition_barriers,
               propagators=propagators,
               functions=functions,
               synthesize_geometries=synthesize_geometries)

环境

此工具不使用任何地理处理环境。

许可信息

  • Basic: 否
  • Standard: 是
  • Advanced: 是

相关主题