SetCircuitSections Method

In This Topic

Sets the circuit sections. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Sub SetCircuitSections( _
   ByVal circuitSections As IReadOnlyDictionary(Of CircuitSection,List(Of CircuitSection)) _
)

public void SetCircuitSections( 
   IReadOnlyDictionary<CircuitSection,List<CircuitSection>> circuitSections
)

Parameters

circuitSections: A dictionary of circuit sections where each key is a CircuitSection that connects to the other CircuitSection objects described by the key's value, in sequential or parallel order.

Exceptions

Exception	Description
System.ArgumentNullException	circuitSections is null or contains a null list of connected circuit sections.
System.ArgumentException	The circuit sections do not have unique section IDs.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.

Example

Create a virtual sectioned circuit in the utility network

await QueuedTask.Run(() =>
{
  using (CircuitManager circuitManager = utilityNetwork.GetCircuitManager(telecomDomainNetwork))
  {
    // Create a sectioned virtual circuit object
    Circuit circuit = new Circuit(circuitManager);
    circuit.SetName(circuitNames.First());
    circuit.SetSectioned(true);
    circuit.SetCircuitType(CircuitType.Virtual);

    CircuitSection circuitSection1 = new CircuitSection(circuitManager);
    circuitSection1.SetSectionType(CircuitSectionType.Virtual);
    circuitSection1.SetStartLocation(new CircuitLocation(startElement));
    circuitSection1.SetStopLocation(new CircuitLocation(stopElement));

    CircuitSection circuitSection2 = new CircuitSection(circuitManager);
    circuitSection2.SetSectionType(CircuitSectionType.Physical);
    circuitSection2.SetStartLocation(new CircuitLocation(startElement));
    circuitSection2.SetStopLocation(new CircuitLocation(stopElement));

    // Add sections in parallel
    Dictionary<CircuitSection, List<CircuitSection>> circuitSections = new Dictionary<CircuitSection,
              List<CircuitSection>> {
                  {
                      circuitSection1,
                      new List < CircuitSection > ()
                  },
                  {
                      circuitSection2,
                      new List < CircuitSection > ()
                  }
        };

    circuit.SetCircuitSections(circuitSections);

    // Create the circuit.

    circuitManager.Create(circuit);
  }
});

Requirements

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

ArcGIS Pro version: 3.7 or higher.

Reference

Circuit Class
Circuit Members

Send feedback