|
名称
|
说明
|
数据类型
|
|
in_utility_network
|
包含要修改的逻辑示意图模板的公共设施网络或追踪网络。
|
Utility Network; Trace Network
|
|
template_name
|
要修改的逻辑示意图模板名称。
|
String
|
|
is_active
|
指定在基于指定模板生成并更新逻辑示意图时，规则是否将处于启用状态。
|
Boolean
|
|
trace_type
|
请指定为了构建逻辑示意图内容将运行的追踪类型。
CONNECTED—当规则启动时，将从逻辑示意图中当前表示的公共设施网络或追踪网络元素开始运行已连接追踪，并沿连接元素向外扩展。 这是默认设置。
SUBNETWORK—当规则启动时，将从逻辑示意图中当前表示的公共设施网络元素开始运行子网追踪，并沿连接元素向外扩展，以查找源或汇，然后从这些源或汇开始，沿相关子网向外扩展。
UPSTREAM—当规则启动时，将从逻辑示意图中当前表示的公共设施网络或追踪网络元素开始运行上游追踪，以发现上游元素。
DOWNSTREAM—当规则启动时，将从逻辑示意图中当前表示的公共设施网络或追踪网络元素开始运行下游追踪，以发现下游元素。
SHORTEST_PATH—当规则启动时，将从逻辑示意图中当前指定为起点的公共设施网络或追踪网络要素开始运行最短路径追踪，以发现这些起点之间最短路径上的要素。 遍历路径的成本取决于为 path_network_weight_name 参数值设置的网络属性，与流向无关。
旧版本：
SHORTEST_PATH 追踪类型在 ArcGIS Pro 3.7 和 ArcGIS Enterprise 12.1 中已弃用。 虽然该类型可继续使用并在下一个主要版本发布之前仍作为可用选项，但我们建议您使用 PATH 追踪类型来返回最短路径。 PATH 追踪类型提供了返回最短路径结果的相同功能，同时还提供了在网络中查找路径的额外功能。
CIRCUIT—当规则启动时，将从逻辑示意图中当前表示的公共设施网络或追踪网络元素开始运行电路追踪。 该追踪将返回物理电路和虚拟电路的电路定义和路径信息。 仅电信域网络支持此选项。
PATH—将运行路径追踪，以识别逻辑示意图生成所用输入追踪位置的起点与终点之间的有效路径。
|
String
|
|
domain_network
（可选）
|
针对公共设施网络运行追踪的域网络名称。 运行子网、上游、下游和电路追踪类型时，此参数为必填项。
|
String
|
|
tier
（可选）
|
针对公共设施网络开始追踪的层名称。 运行已连接追踪类型时可以使用此参数；运行子网、上游和下游追踪类型时必须使用此参数。
|
String
|
|
target_tier
（可选）
|
公共设施网络输入层流向的目标层名称。 如果上溯和下溯追踪的此参数丢失，当到达起始子网边界时，上述追踪将停止。 该参数可以使此类追踪在层级结构中继续向上或向下延伸。
|
String
|
|
include_structures
（可选）
|
指定追踪结果中是否包含结构要素和对象。
|
Boolean
|
|
include_barriers
（可选）
|
指定追踪结果中是否包含可遍历性障碍要素。 即使已在子网定义中进行了预设，可遍历性障碍仍可选。 此参数不适用于具备终端的设备要素。
|
Boolean
|
|
condition_barriers
[[Name, Operator, Type, Value, Combine Using],...]
（可选）
|
基于与网络属性的比较或对类别字符串的检查，对要素设置可遍历性障碍条件。 条件障碍根据网络属性或类别、操作符、类型及属性值来定义。 例如，当要素的 Device Status 属性等于特定值 Open 时，将停止追踪。 当要素满足此条件时，追踪将停止。
值表列：
Name—Filter by any network attribute defined in the system.
Operator—Choose from a number of different operators.
IS_EQUAL_TO—The attribute is equal to the value.
DOES_NOT_EQUAL—The attribute is not equal to the value.
IS_GREATER_THAN—The attribute is greater than the value.
IS_GREATER_THAN_OR_EQUAL_TO—The attribute is greater than or equal to the value.
IS_LESS_THAN—The attribute is less than the value.
IS_LESS_THAN_OR_EQUAL_TO—The attribute is less than or equal to the value.
INCLUDES_THE_VALUES—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).
DOES_NOT_INCLUDE_THE_VALUES—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).
INCLUDES_ANY—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).
DOES_NOT_INCLUDE_ANY—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).
Type—Choose a specific value or network attribute from the value that is specified with the name.
Value—Provide a specific value for the input attribute type that would cause termination based on the operator value.
Combine Using—Set this value if you have multiple attributes to add. You can combine them using an And or an Or condition.
|
Value Table
|
|
function_barriers
[[Function, Attribute, Operator, Value, Use Local Values],...]
（可选）
|
基于函数对要素设置可遍历性障碍。 函数障碍可用于执行以下操作：限制追踪距离起点的行程或设置停止追踪的最大值。 例如，所经过的每条线的长度和为目前经过的总距离。 当经过的总长度达到指定值时，追踪将停止。
值表列：
Function—Choose from a number of different calculation functions.
MIN—The minimum of the input values will be used.
MAX—The maximum of the input values will be used.
AVERAGE—The average of the input values will be used.
COUNT—The number of features will be used.
ADD—The sum of the values will be used.
SUBTRACT—The difference between the values will be used. Subnetwork controllers and loops trace types do not support the subtract function.
Attribute—Filter by any network attribute defined in the system.
Operator—Choose from a number of different operators.
IS_EQUAL_TO—The attribute is equal to the value.
DOES_NOT_EQUAL—The attribute is not equal to the value.
IS_GREATER_THAN—The attribute is greater than the value.
IS_GREATER_THAN_OR_EQUAL_TO—The attribute is greater than or equal to the value.
IS_LESS_THAN—The attribute is less than the value.
IS_LESS_THAN_OR_EQUAL_TO—The attribute is less than or equal to the value.
INCLUDES_THE_VALUES—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).
DOES_NOT_INCLUDE_THE_VALUES—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).
INCLUDES_ANY—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).
DOES_NOT_INCLUDE_ANY—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).
Value—Provide a specific value for the input attribute type that, if discovered, will cause the termination.
Use Local Values—Calculate values in each direction as opposed to an overall global value. For example, a function barrier that is calculating the sum of Shape length in which the trace terminates if the value is greater than or equal to 4. In the global case, after you traverse two edges with a value of 2, you will have reached a shape length sum of 4, so the trace stops. If local values are used, the local values along each path change, and the trace continues.
|
Value Table
|
|
traversability_scope
（可选）
|
指定将应用的可遍历性类型。 可遍历性范围用于定义是否将在交汇点和/或边处应用可遍历性。 例如，如果定义了用于停止追踪的条件障碍，其中 Device Status 等于 Open 并将遍历范围仅设置为边，则即使追踪遇到开路设备，追踪也不会停止，因为 Device Status 仅适用于交汇点。 换言之，此参数会为追踪指明是否要忽略交汇点和/或边。
|
String
|
|
filter_barriers
[[Name, Operator, Type, Value, Combine Using],...]
（可选）
|
用于指定针对特定类别或网络属性的追踪停止时间。 例如，针对生命周期状态属性等于特定值的要素，追踪停止。 此参数用于根据系统中定义的网络属性值设置终止符。
值表列：
Name—Filter by category or any network attribute defined in the system.
Operator—Choose from a number of different operators.
IS_EQUAL_TO—The attribute is equal to the value.
DOES_NOT_EQUAL—The attribute is not equal to the value.
IS_GREATER_THAN—The attribute is greater than the value.
IS_GREATER_THAN_OR_EQUAL_TO—The attribute is greater than or equal to the value.
IS_LESS_THAN—The attribute is less than the value.
IS_LESS_THAN_OR_EQUAL_TO—The attribute is less than or equal to the value.
INCLUDES_THE_VALUES—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).
DOES_NOT_INCLUDE_THE_VALUES—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).
INCLUDES_ANY—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).
DOES_NOT_INCLUDE_ANY—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).
Type—Choose a specific value or network attribute from the value that is specified with the name.
Value—Provide a specific value of the input attribute type that would cause termination based on the operator value.
Combine Using—Set this value if you have multiple attributes to add. You can combine them using an And or an Or condition.
|
Value Table
|
|
filter_function_barriers
[[Function, Attribute, Operator, Value, Use Local Values],...]
（可选）
|
用于过滤特定类别的追踪结果。
值表列：
Function—Filter by a function.
MIN—The minimum of the input values will be used.
MAX—The maximum of the input values will be used.
AVERAGE—The average of the input values will be used.
COUNT—The number of features will be used.
ADD—The sum of the values will be used.
SUBTRACT—The difference between the values will be used. Subnetwork controllers and loops trace types do not support the subtract function.
Attribute—Filter by a network attribute.
Operator—Filter by an operator.
IS_EQUAL_TO—The attribute is equal to the value.
DOES_NOT_EQUAL—The attribute is not equal to the value.
IS_GREATER_THAN—The attribute is greater than the value.
IS_GREATER_THAN_OR_EQUAL_TO—The attribute is greater than or equal to the value.
IS_LESS_THAN—The attribute is less than the value.
IS_LESS_THAN_OR_EQUAL_TO—The attribute is less than or equal to the value.
INCLUDES_THE_VALUES—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).
DOES_NOT_INCLUDE_THE_VALUES—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).
INCLUDES_ANY—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).
DOES_NOT_INCLUDE_ANY—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).
Value—Filter by a specific value.
Use Local Values—Boolean value to use local variables instead of a global variable.
|
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
|
|
propagators
[[Attribute, Substitution Attribute, Function, Operator, Value],...]
（可选）
|
指定在传统域网络中的追踪过程中，需要传播的网络属性及其传播方式。 传播的类属性表示子网控制器上已传播至子网余下要素的关键值。 例如，在配电模型中，您可传播相位值。
值表列：
Attribute—Filter by any network attribute defined in the system.
Substitution Attribute—Use a substituted value instead of bitset network attribute values. Substitutions are encoded based on the number of bits in the network attribute being propagated. A substitution is a mapping of each bit in phase to another bit. For example, for Phase AC, one substitution could map bit A to B, and bit C to null. In this example, the substitution for 1010 (Phase AC) is 0000-0010-0000-0000 (512). The substitution captures the mapping so you know that Phase A was mapped to B and Phase C was mapped to null, and not the other way around (that is, Phase A was not mapped to null and Phase C was not mapped to B).
Function—Choose from a number of calculation functions.
PROPAGATED_BITWISE_AND—Compare the values from one feature to the next.
PROPAGATED_MIN—The minimum value will be used.
PROPAGATED_MAX—The maximum value will be used.
Operator—Choose from a number of operators.
IS_EQUAL_TO—The attribute is equal to the value.
DOES_NOT_EQUAL—The attribute is equal to the value.
IS_GREATER_THAN—The attribute is greater than the value.
IS_GREATER_THAN_OR_EQUAL_TO—The attribute is greater than or equal to the value.
IS_LESS_THAN—The attribute is less than the value.
IS_LESS_THAN_OR_EQUAL_TO—The attribute is less than or equal to the value.
INCLUDES_THE_VALUES—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).
DOES_NOT_INCLUDE_THE_VALUES—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).
INCLUDES_ANY—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).
DOES_NOT_INCLUDE_ANY—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).
Value—Provide a specific value for the input attribute type that would cause termination based on the operator value.
|
Value Table
|
|
description
（可选）
|
规则的描述。
|
String
|
|
allow_indeterminate_flow
（可选）
|
指定是否将追踪具有不确定或未初始化流向的追踪网络要素。 此参数仅在运行上游追踪或下游追踪类型时使用。
|
Boolean
|
|
path_direction
（可选）
|
指定追踪网络中最短路径的方向。 遍历路径的成本取决于 path_network_weight_name 参数值。 仅在针对追踪网络应用 SHORTEST_PATH 追踪类型时，才会使用此参数。
NO_DIRECTION—最短路径位于两个起点之间，无论流向如何。 这是默认设置。
PATH_UPSTREAM—最短路径方向将是两个起点之间的上游方向。
PATH_DOWNSTREAM—最短路径方向将是两个起点之间的下游方向。
|
String
|
|
path_network_weight_name
（可选）
|
在使用路径或最短路径追踪类型时，用于计算公共设施网络或追踪网络最短路径的网络属性。 运行最短路径追踪类型时，使用数字网络属性（例如形状长度）计算最短路径。 基于成本和距离的路径都可以进行计算。 运行最短路径追踪时，需要此参数。
|
String
|
|
use_trace_config
（可选）
|
指定是否将使用现有指定追踪配置来定义追踪的属性。 此参数仅适用于 Utility Network 版本 7 及更高版本。
|
Boolean
|
|
trace_config_name
（可选）
|
将用于定义追踪属性的现有指定追踪配置的名称。 仅当将 use_trace_config 参数设置为 USE_TRACE_CONFIGURATION 时，才会启用此参数。
|
String
|
|
use_digitized_direction
（可选）
|
指定上游和下游跟踪操作是否将使用线的数字化方向和 Flow direction 属性来确定流量。 当 trace_type 参数设置为 UPSTREAM 或 DOWNSTREAM 选项时，仅针对 Utility Network 版本 7 及更高版本启用此参数。
注:
使用企业级地理数据库时，此参数需要 ArcGIS Enterprise 11.3 或更高版本。
|
Boolean
|
|
output_assettypes
[output_assettypes,...]
（可选）
|
过滤要包含在结果中的输出资产类型 - 例如，仅返回架空变压器。
|
String
|
|
output_conditions
[[Name, Operator, Type, Value, Combine Using],...]
（可选）
|
按网络属性或类别返回的要素类型。 例如，如果将追踪配置为“过滤掉除水龙头要素外的所有要素”，那么未分配水龙头类别的追踪要素均不会包含在结果中。 任何追踪的要素都会返回到结果选择集中。 如果要使用多个属性，可使用 Combine Using 选项来定义 And 或 Or 条件。
值表列：
Name—Filter by network attribute name.
Operator—Filter by an operator.
IS_EQUAL_TO—The attribute is equal to the value.
DOES_NOT_EQUAL—The attribute is not equal to the value.
IS_GREATER_THAN—The attribute is greater than the value.
IS_GREATER_THAN_OR_EQUAL_TO—The attribute is greater than or equal to the value.
IS_LESS_THAN—The attribute is less than the value.
IS_LESS_THAN_OR_EQUAL_TO—The attribute is less than or equal to the value.
INCLUDES_THE_VALUES—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).
DOES_NOT_INCLUDE_THE_VALUES—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).
INCLUDES_ANY—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).
DOES_NOT_INCLUDE_ANY—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).
Type—Filter by a specific type.
Value—Filter by a specific value.
Combine Using—Use this parameter to combine multiple conditions.
|
Value Table
|
|
num_paths
（可选）
|
路径或电路追踪中将返回的最大路径数。 默认值为 1。 仅当 trace_type 参数设置为 PATH 或 CIRCUIT 时，此参数才处于活动状态。
|
Long
|
|
max_hops
（可选）
|
路径或电路中允许的边之间的最大跳数（不包括起点）。 所有边以及交汇点-交汇点连通性关联在遍历时均被评估为具有固定单位长度 1。 终端设备被评估为具有固定单位长度 2。 默认值为 100。 仅当 trace_type 参数设置为 PATH 或 CIRCUIT 时，此参数才有效。
|
Long
|
|
infer_connectivity
（可选）
|
指定路径追踪是否将使用连通性推断来遍历包含关联并识别指定的起始位置与停止位置之间的路径。 仅电信域网络中的路径追踪支持此参数，可实现在未明确提供连通性信息时发现分段间的路径。 有关详细信息，请参阅推断连通性。
|
Boolean
|
，直到对其进行更新为止。