GetNamedTraceConfigurations Method (TraceManager)

In This Topic

Gets the NamedTraceConfigurations associated with a ArcGIS.Core.Data.UtilityNetwork.UtilityNetwork. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public IReadOnlyList<NamedTraceConfiguration> GetNamedTraceConfigurations( 
   NamedTraceConfigurationQuery parameters
)

Public Function GetNamedTraceConfigurations( _
   ByVal parameters As NamedTraceConfigurationQuery _
) As IReadOnlyList(Of NamedTraceConfiguration)

Parameters

parameters: Represents a filter to return a desired set of NamedTraceConfigurations. If the filter consists of all empty or null lists, then return all named trace configurations.

Return Value

A read-only list of NamedTraceConfigurations.

Exceptions

Exception	Description
System.InvalidOperationException	The utility network has a ArcGIS.Core.Data.UtilityNetwork.UtilityNetworkDefinition.GetSchemaVersion less than `5`.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.

Example

Fetch a named trace configuration by name

private NamedTraceConfiguration GetNamedTraceConfigurationsByName(UtilityNetwork utilityNetwork, string configurationName = "WaterNetwork")
{
  // Query to find named trace configurations
  NamedTraceConfigurationQuery namedTraceConfigurationQuery = new NamedTraceConfigurationQuery { Names = new List<string> { configurationName } };

  // Get the trace manager from the utility network
  using (TraceManager traceManager = utilityNetwork.GetTraceManager())
  {
    // A set of named trace configurations specified by the named traced configuration query 
    IReadOnlyList<NamedTraceConfiguration> namedTraceConfigurations = traceManager.GetNamedTraceConfigurations(namedTraceConfigurationQuery);
    NamedTraceConfiguration waterConfiguration = namedTraceConfigurations.First(f => f.Description.Equals(configurationName));

    return waterConfiguration;
  }
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

TraceManager Class
TraceManager Members

Send feedback