ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Core.Data.UtilityNetwork.Telecom Namespace / CircuitManager Class / GetCircuitNames Method
The filter parameters.
Example

In This Topic
    GetCircuitNames Method
    In This Topic
    Gets the names of the circuits in relation to the provided filter. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    Public Function GetCircuitNames( _
       ByVal circuitFilter As CircuitFilter _
    ) As IReadOnlyList(Of String)

    Parameters

    circuitFilter
    The filter parameters.

    Return Value

    The read-only list of circuit names.
    Exceptions
    ExceptionDescription
    circuitFilter is null.
    circuitFilter is invalid.
    A geodatabase-related exception has occurred.
    Example
    Get all circuits at a specific location within the utility network
    await QueuedTask.Run(() =>
    {
      using (CircuitManager circuitManager = utilityNetwork.GetCircuitManager(telecomDomainNetwork))
      {
        // Define a location in the utility network.
        CircuitLocation location = new CircuitLocation(startElement);
    
        // Get circuit names from the start location
        CircuitFilter circuitFilter = new CircuitFilter([location], CircuitLocationTypeFilter.All) { Hierarchy = CircuitHierarchy.ConsumersAndProviders };
        IReadOnlyList<string> circuitNames = circuitManager.GetCircuitNames(circuitFilter);
    
        // Get circuits from the start location
        IReadOnlyList<Circuit> circuits = circuitManager.GetCircuits(circuitFilter);
    
        // Get circuits by names
        circuitFilter = new CircuitFilter(circuitNames);
        circuits = circuitManager.GetCircuits(circuitFilter);
    
        // Iterate through the circuits.
        foreach (Circuit circuit in circuits)
        {
          Console.WriteLine($"Circuit name: {circuit.GetName()}");
        }
      }
    
    });
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.7 or higher.
    See Also