EnableController Method

Enables a feature corresponding to to be a SubnetworkController and adds it to an existing Subnetwork corresponding to . If the specified subnetwork does not exist, a new one will be created. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public Subnetwork EnableController( 
   Tier tier,
   Element device,
   string subnetworkName,
   string controllerName,
   string description,
   string notes
)

Public Function EnableController( _
   ByVal tier As Tier, _
   ByVal device As Element, _
   ByVal subnetworkName As String, _
   ByVal controllerName As String, _
   ByVal description As String, _
   ByVal notes As String _
) As Subnetwork

Parameters

tier: The Tier to which the Subnetwork is created.
device: Corresponds to the feature to be enabled as a SubnetworkController. This Element must specify a terminal, and this terminal must be specified as a Controller Terminal in the terminal definition.
subnetworkName: Name of the subnetwork.
controllerName: Name of the subnetwork controller.
description: A description for the subnetwork controller.
notes: Additional notes for the subnetwork controller.

Return Value

The newly-created or modified subnetwork.

Exceptions

Exception	Description
System.InvalidOperationException	If the Terminal in device is null and the associated TerminalConfiguration has multiple terminals.
ArcGIS.Core.Data.GeodatabaseException	A geodatabase-related exception has occurred.

Remarks

This routine generates its own editing transaction and therefore cannot be wrapped inside a separate transaction.
When writing an ArcGIS Pro add-in, the extension method ArcGIS.Core.Data.UtilityNetwork.Extensions.UtilityNetworkExtensions.EnableControllerInEditOperation should be used instead. This extension method will create an edit operation on the Pro undo/redo stack and redraw any affected layers.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 7

Reference

SubnetworkManager Class
SubnetworkManager Members