Utility network trace parameters. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.6 |
| Inherits: |
Properties
- barriers : list<UtilityElement>
- filterBarriers : list<UtilityElement>
- resultTypes : list<Enums.UtilityTraceType>
- startingLocations : list<UtilityElement>
- traceConfiguration : UtilityTraceConfiguration
- traceType : Enums.UtilityTraceType
Signals
- barriersChanged()
- filterBarriersChanged()
- resultTypesChanged()
- startingLocationsChanged()
- traceConfigurationChanged()
- traceTypeChanged()
Detailed Description
If you would like to create this type from utilityNamedTraceConfiguration and startingLocations, then you can see the following code block:
property var locations; // starting location you got from elsewhere property var namedTraceConfiguration; // received from elsewhere UtilityTraceParameters { startingLocations: locations resultTypes: namedTraceConfiguration.resultTypes traceConfiguration: namedTraceConfiguration.traceConfiguration traceType: namedTraceConfiguration.traceType }
See also UtilityNetwork::trace.
Property Documentation
barriers : list<UtilityElement> |
The list of barriers to use in the trace operation.
Barriers are used in traces to mark the locations to stop tracing.
To update the barriers list, assign a new JavaScript array that contains the desired elements:
params.barriers = [barrier1, barrier2, barrier3];
filterBarriers : list<UtilityElement> |
The collection of filter barriers.
A regular barrier, specified by barriers, prevents traversal which, when used with subnetwork-based traces, can prevent traversal to the subnetwork controller. Like UtilityTraceConfiguration::filter, filter barriers are evaluated in the second pass of a trace. Therefore, it can restrict the result set without impacting the ability to find subnetwork controllers from starting points.
One example of where filter barriers can be used is in the gas distribution domain. Filter barriers can be used to simulate the location of a squeeze-off when executing a valve isolation trace. The user can place a filter barrier at the proposed location of the squeeze-off and then verify its impact, using a trace.
To update the filterBarriers list, assign a new JavaScript array that contains the desired elements:
params.filterBarriers = [barrier1, barrier2, barrier3];
This property was introduced in Esri.ArcGISRuntime 100.10.
Returns a collection that is pre-populated with the default of Enums.UtilityTraceResultTypeElements.
This corresponds to the UtilityTraceResult collection returned by UtilityNetwork::trace.
See also Enums.UtilityTraceType.
startingLocations : list<UtilityElement> |
The list of starting locations to use in the trace operation.
A starting point defines the location in the network where a trace begins.
To update the starting location list, assign a new JavaScript array that contains the desired elements:
params.startingLocations = [location1, location2, location3];
traceConfiguration : UtilityTraceConfiguration |
The complete collection of trace options.
This property was introduced in Esri.ArcGISRuntime 100.7.
The traceType of the UtilityTraceParameters.
See also Enums.UtilityTraceType.
Signal Documentation
Emitted when the barriers property changes.
Note: The corresponding handler is onBarriersChanged.
Emitted when the filterBarriers property changes.
Note: The corresponding handler is onFilterBarriersChanged.
This signal was introduced in Esri.ArcGISRuntime 100.10.
Emitted when the resultTypes property changes.
Note: The corresponding handler is onResultTypesChanged.
Emitted when the startingLocations property changes.
Note: The corresponding handler is onStartingLocationsChanged.
Emitted when the traceConfiguration property changes.
Note: The corresponding handler is onTraceConfigurationChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the traceType property changes.
Note: The corresponding handler is onTraceTypeChanged.