The UNTraceConfiguration class contains properties required to define objects than can be used to run custom traces on utility networks. A UNTraceConfiguration differs from a TraceConfiguration slightly because a UNTraceConfiguration contains parameters that are only applicable or relevant to utility networks.
- See also
// create a new instance of UNTraceConfiguration
// and configure some parameters
const unTraceConfiguration = new UNTraceConfiguration({
domainNetworkName: "Electric",
tierName: "Electric Distribution",
subnetworkName: "RMT003",
includeContainers: true,
validateConsistency: true,
// Traversability
conditionBarriers: [
{
name: "E:Device Status",
type: "networkAttribute",
operator: "equal",
value: 1,
combineUsingOr: false,
isSpecificValue: true
}
],
traversabilityScope: "junctionsAndEdges",
});Constructors
-
new UNTraceConfiguration(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | Specifies the name of the domain network where the trace will be run. more details | UNTraceConfiguration | |
| Object[] | An array of objects representing specific categories or network attributes where the trace will stop. more details | UNTraceConfiguration | |
| String | Ensures the trace results include any bit that is set in the starting points for the network attribute. more details | UNTraceConfiguration | |
| Object[] | An array of objects representing filter function barriers. more details | UNTraceConfiguration | |
| String | Specifies where the filter will be applied. more details | UNTraceConfiguration | |
| Boolean | Specifies if the container features will be included in the trace results. more details | UNTraceConfiguration | |
| Boolean | Specifies if the content in containers will be included in the results. more details | UNTraceConfiguration | |
| Boolean | Specifies whether to include isolated features for an isolation trace. more details | UNTraceConfiguration | |
| Boolean | Specifies if structure features and objects will be included in the trace results. more details | UNTraceConfiguration | |
| Boolean | Specifies whether to limit the containers returned to include only those encountered up to, and including, the first spatial container for each network element in the trace results. more details | UNTraceConfiguration | |
| Object | Specifies the parameters needed for calculating nearest neighbors. more details | UNTraceConfiguration | |
| Object[] | An array of objects representing the output filter categories. more details | UNTraceConfiguration | |
| Object[] | An array of objects used to control what is returned in the results of a trace. more details | UNTraceConfiguration | |
| Object[] | A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. more details | UNTraceConfiguration | |
| String | Specifies the name of the subnetwork where the trace will be run. more details | UNTraceConfiguration | |
| String | Specifies the name of the tier where an upstream or downstream trace ends. more details | UNTraceConfiguration | |
| String | Specifies the name of the tier where the trace will be run. more details | UNTraceConfiguration | |
| Boolean | Specifies if its necessary to validate whether traversed junction or edge objects have the necessary containment, attachment, or connectivity association in their association hierarchy. more details | UNTraceConfiguration |
Property Details
-
domainNetworkName String
-
Specifies the name of the domain network where the trace will be run.
- See also
-
An array of objects representing specific categories or network attributes where the trace will stop.
-
filterBitsetNetworkAttributeName String
-
Ensures the trace results include any bit that is set in the starting points for the network attribute.
-
An array of objects representing filter function barriers.
-
filterScope String
-
Specifies where the filter will be applied.
Value Description junctions Filter will be applied to junctions only. edges Filter will be applied to edges only. junctionsAndEdges Filter will be applied to both junctions and edges. Possible Values:"junctions"|"edges"|"junctionsAndEdges"
-
includeContainers Boolean
-
Specifies if the container features will be included in the trace results.
-
includeContent Boolean
-
Specifies if the content in containers will be included in the results.
-
includeIsolated Boolean
-
Specifies whether to include isolated features for an isolation trace.
-
includeStructures Boolean
-
Specifies if structure features and objects will be included in the trace results.
-
includeUpToFirstSpatialContainer Boolean
-
Specifies whether to limit the containers returned to include only those encountered up to, and including, the first spatial container for each network element in the trace results.
-
nearestNeighbor Object
-
Specifies the parameters needed for calculating nearest neighbors. Nearest neighbor is used to return a number of features of a certain type within a given distance.
-
An array of objects representing the output filter categories.
-
An array of objects used to control what is returned in the results of a trace.
-
A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. Propagators are only applicable to subnetwork-based traces (subnetwork, subnetworksource, upstream, or downstream).
- See also
-
subnetworkName String
-
Specifies the name of the subnetwork where the trace will be run.
-
targetTierName String
-
Specifies the name of the tier where an upstream or downstream trace ends.
- See also
-
tierName String
-
Specifies the name of the tier where the trace will be run.
-
validateLocatability Boolean
-
Specifies if its necessary to validate whether traversed junction or edge objects have the necessary containment, attachment, or connectivity association in their association hierarchy.