Trace(TraceArgument,ServiceSynchronizationType) Method

ArcGIS.Core.Data.UtilityNetwork.Trace Namespace / Tracer Class / Trace Method / Trace(TraceArgument,ServiceSynchronizationType) Method

Collapse All

In This Topic

Syntax
Exceptions
Remarks
Requirements
See Also

Trace(TraceArgument,ServiceSynchronizationType) Method

In This Topic

Syntax
Exceptions
Remarks
Requirements
See Also

Executes a trace.

Syntax

C#
Visual Basic (Declaration)

public abstract IReadOnlyList<Result> Trace( 
   TraceArgument traceArgument,
   ServiceSynchronizationType serviceSynchronizationType
)

Public Overloads MustOverride Function Trace( _
   ByVal traceArgument As TraceArgument, _
   ByVal serviceSynchronizationType As ServiceSynchronizationType _
) As IReadOnlyList(Of Result)

Parameters

traceArgument: The input arguments to the trace.
serviceSynchronizationType: Specifies which implementation of the service endpoint to call. This parameter is ignored for non-services based utility networks.

Return Value

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

Exceptions

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.

Remarks

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.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.2 or higher.

Reference

Tracer Class
Tracer Members
Overload List

Send feedback