trace

suspend fun trace(traceParameters: UtilityTraceParameters): Result<List<UtilityTraceResult>>

Begins a trace with the supplied UtilityTraceParameters. This method returns a task that supplies a collection of UtilityTraceResult objects when the utility network finishes the trace.

If the UtilityTraceParameters.traceType in UtilityTraceParameters is a subnetwork-based trace, it must have an UtilityDomainNetwork set in the UtilityTraceConfiguration returned from UtilityTraceParameters.traceConfiguration.

Return

An array of UtilityTraceResult objects when the trace is finished.

Since

200.1.0

Parameters

traceParameters

The input arguments to the trace.