GetTracer(NamedTraceConfiguration) Method

In This Topic

Gets a specific Tracer instance based on the . This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public Tracer GetTracer( 
   NamedTraceConfiguration namedTraceConfiguration
)

Public Overloads Function GetTracer( _
   ByVal namedTraceConfiguration As NamedTraceConfiguration _
) As Tracer

Parameters

namedTraceConfiguration: The named trace configuration that the output tracer is associated with.

Return Value

A specific Tracer instance corresponding to the .

Exceptions

Exception	Description
System.Exception	An exception has occurred while creating the tracer.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run

Example

Create a DownstreamTracer

using (TraceManager traceManager = utilityNetwork.GetTraceManager())
{
  DownstreamTracer downstreamTracer = traceManager.GetTracer<DownstreamTracer>();
}

Trace a utility network using a named trace configuration

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);
  }
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

TraceManager Class
TraceManager Members
Overload List

Send feedback