CircuitFilter Constructor(IEnumerable<CircuitLocation>,CircuitLocationTypeFilter)

In This Topic

Constructs a filter based on circuit locations.

Syntax

Visual Basic (Declaration)
C#

Public Function New( _
   ByVal locations As IEnumerable(Of CircuitLocation), _
   ByVal locationType As CircuitLocationTypeFilter _
)

public CircuitFilter( 
   IEnumerable<CircuitLocation> locations,
   CircuitLocationTypeFilter locationType
)

Parameters

locations: The locations starting at, stopping at, or along a circuit.
locationType: Whether the locations are starting at, stopping at, or along a circuit.

Exceptions

Exception	Description
System.ArgumentException	locations is empty or locationType is not a valid value.
System.ArgumentNullException	locations is null.

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.

Reference

CircuitFilter Class
CircuitFilter Members
Overload List

Send feedback