TraceConfiguration 类提供了配置运行网络跟踪所需的自定义跟踪属性的能力。 这些属性控制可遍历性、函数、过滤器和输出的跟踪设置。 配置跟踪和添加跟踪配置(公共设施网络)文档有助于了解有关跟踪配置参数的更多信息。
跟踪配置不同于 NamedTraceConfiguration。 NamedTraceConfiguration 允许在公共设施网络中的复杂轨迹上配置和存储属性。 这些配置是在公共设施网络中创建和存储的,并且可以在整个组织中重复使用和共享。 命名的跟踪配置可以由 globalID引用。
使用 TraceConfiguration 的好处是能够配置自定义跟踪属性,而无需在公共设施网络中创建和共享新的命名跟踪配置。 这改善了用户体验,因为它不需要用户了解创建完整命名跟踪配置的所有细节。 用户可以只修改某些跟踪属性,然后执行他们自己的自定义跟踪。 为了实现这一点,用户可以获取 utility network 中可用的 NamedTraceConfigurations 并覆盖它。 要覆盖现有的命名跟踪配置,请创建一个 TraceConfiguration 实例并将其分配给 NamedTraceConfiguration 的 traceConfiguration 属性。
- 示例:
-
- UtilityNetwork
- NamedTraceConfiguration
- TraceParameters
Configure a trace
Add Trace Configuration (Utility Network)
构造函数
属性列表
属性 | 类型 | 描述 | 类 | |
---|---|---|---|---|
Object[] | 更多信息 表示用作障碍的网络属性或类别条件的对象数组。 | 更多信息 | TraceConfiguration | |
Object[] | 更多信息 表示功能障碍的对象数组。 | 更多信息 | TraceConfiguration | |
Object[] | 更多信息 表示函数的对象数组。 | 更多信息 | TraceConfiguration | |
Boolean | 更多信息 如果起点是障碍物,则不要停止跟踪。 | 更多信息 | TraceConfiguration | |
Boolean | 更多信息 指定追踪结果中是否包含可遍历性障碍要素。 | 更多信息 | TraceConfiguration | |
Object[] | 更多信息 指定基于网络属性或检查类别字符串返回的要素类型。 | 更多信息 | TraceConfiguration | |
String | 更多信息 指定用于确定最短路径的网络属性名称。 | 更多信息 | TraceConfiguration | |
String | 更多信息 确定是否将可遍历性应用于交汇点和边、仅应用于交汇点还是仅应用于边。 | 更多信息 | TraceConfiguration | |
Boolean | 更多信息 指定在任何遍历的要素中遇到脏区时是否返回错误。 | 更多信息 | TraceConfiguration |
属性详细说明
-
表示用作障碍的网络属性或类别条件的对象数组。
-
表示功能障碍的对象数组。 函数障碍定义了当满足聚合函数条件时应该停止跟踪的时间。 例如,当形状长度网络属性的总和超过 100 米时停止追踪。
-
表示函数的对象数组。 函数允许对与追踪的网络要素关联的网络属性运行计算。 可以为单个跟踪指定多个函数。
-
ignoreBarriersAtStartingPoints Boolean
-
如果起点是障碍物,则不要停止跟踪。
-
includeBarriers Boolean
-
指定追踪结果中是否包含可遍历性障碍要素。
-
指定基于网络属性或检查类别字符串返回的要素类型。 条件障碍使用网络属性、运算符、类型和属性值。
- 示例:
-
Trace REST API
-
shortestPathNetworkAttributeName String
-
指定用于确定最短路径的网络属性名称。 最短路径是使用数字网络属性(例如形状长度)计算的。
-
traversabilityScope String
-
确定是否将可遍历性应用于交汇点和边、仅应用于交汇点还是仅应用于边。 例如,如果我们将
traversabilityScope
设置为junctions
,则不会根据可遍历性条件和过滤器评估edges
。值 描述 junctions 可遍历性将仅应用于交汇点。
edges 可遍历性将仅应用于边。
junctionsAndEdges 可遍历性将应用于交汇点和边。
可选值:"junctions"|"edges"|"junctionsAndEdges"
-
validateConsistency Boolean
-
指定在任何遍历的要素中遇到脏区时是否返回错误。 如果设置为
false
,即使遇到脏区,跟踪也会成功。 但是,跟踪结果可能不一致。