Trace Method (Tracer)

C#
Visual Basic (Declaration)

public abstract IReadOnlyList<Result> Trace( 
   TraceArgument traceArgument
)

Public MustOverride Function Trace( _
   ByVal traceArgument As TraceArgument _
) As IReadOnlyList(Of Result)

Parameters

traceArgument: The input arguments to the trace.

Return Value

A IReadOnlyList of concrete Result whose type corresponds to ResultType set in TraceArgument.ResultTypes.

Exception	Description
System.ArgumentNullException	traceArgument is null.
System.NotSupportedException	This operation is not supported in client-server mode.
System.InvalidOperationException	If the ArcGIS.Core.Data.UtilityNetwork.Terminal in any ArcGIS.Core.Data.UtilityNetwork.Element in TraceArgument.StartingLocations, TraceArgument.Barriers or TraceArgument.FilterBarriers is null and the associated ArcGIS.Core.Data.UtilityNetwork.TerminalConfiguration has multiple terminals.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.

Derived implementations may impose stronger preconditions. For example, a concrete Tracer implementation may throw a System.ArgumentException if is created using the TraceArgument.TraceArgument Constructor(Subnetwork) constructor when ArcGIS.Core.Data.UtilityNetwork.Subnetwork does not apply to the particular tracer.

Trace a utility network using a named trace configuration

C#

private void TraceUtilityNetworkUsingNamedTraceConfiguration(UtilityNetwork utilityNetwork, NamedTraceConfiguration namedTraceConfiguration, Element startElement)
{
  // Get the trace manager from the utility network
  using (TraceManager traceManager = utilityNetwork.GetTraceManager())
  {
    // Get a tracer from the trace manager using the named trace configuration
    Tracer upstreamTracer = traceManager.GetTracer(namedTraceConfiguration);
    
    // Trace argument holding the trace input parameters
    TraceArgument upstreamTraceArgument = new TraceArgument(namedTraceConfiguration, new List<Element> {startElement});
    
    // Trace results 
    IReadOnlyList<Result> upstreamTraceResults = upstreamTracer.Trace(upstreamTraceArgument);
  }
}

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

Tracer Class
Tracer Members