TraceArgument Constructor(NamedTraceConfiguration,IEnumerable<Element>)

In This Topic

Initializes a new instance of the TraceArgument class using a and .

Syntax

C#
Visual Basic (Declaration)

public TraceArgument( 
   NamedTraceConfiguration namedTraceConfiguration,
   IEnumerable<Element> startingLocations
)

Public Function New( _
   ByVal namedTraceConfiguration As NamedTraceConfiguration, _
   ByVal startingLocations As IEnumerable(Of Element) _
)

Parameters

namedTraceConfiguration: The trace configuration for the trace.
startingLocations: A set of starting locations from which to originate the trace.

Exceptions

Exception	Description
System.ArgumentNullException	namedTraceConfiguration or startingLocations is null. -or- Any ArcGIS.Core.Data.UtilityNetwork.Element in startingLocations is null.
System.ArgumentException	startingLocations is empty.

Exception

Description

System.ArgumentNullException

namedTraceConfiguration or startingLocations is null.

-or-

Any ArcGIS.Core.Data.UtilityNetwork.Element in startingLocations is null.

System.ArgumentException

is empty.

Example

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

TraceArgument Class
TraceArgument Members
Overload List

Send feedback