Export Method (Subnetwork)

In This Topic

Exports information about a subnetwork into a JSON file. This also deletes rows in the Subnetworks table that are marked as deleted.

Syntax

C#
Visual Basic (Declaration)

public void Export( 
   Uri outputJsonPath,
   SubnetworkExportOptions subnetworkExportOptions
)

Public Sub Export( _
   ByVal outputJsonPath As Uri, _
   ByVal subnetworkExportOptions As SubnetworkExportOptions _
)

Parameters

outputJsonPath: The path of a JSON file where the information about a subnetwork will be exported.
subnetworkExportOptions: The options describing how a subnetwork will be exported.

Exceptions

Exception	Description
System.ArgumentException	outputJsonPath must have the .json extension.
System.ArgumentNullException	outputJsonPath or subnetworkExportOptions is null.
System.InvalidOperationException	Export cannot be performed in an active edit session.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.

Example

Export Subnetwork

public void ExportSubnetwork(UtilityNetwork utilityNetwork, string subnetworkName, Uri exportResultJsonPath)
{
  using (UtilityNetworkDefinition utilityNetworkDefinition = utilityNetwork.GetDefinition())
  using (SubnetworkManager subnetworkManager = utilityNetwork.GetSubnetworkManager())
  {
    Subnetwork subnetwork = subnetworkManager.GetSubnetwork(subnetworkName);

    IReadOnlyList<NetworkAttribute> networkAttributes = utilityNetworkDefinition.GetNetworkAttributes();
    IReadOnlyList<NetworkSource> networkSources = utilityNetworkDefinition.GetNetworkSources();

    // Export options
    SubnetworkExportOptions subnetworkExportOptions = new SubnetworkExportOptions()
    {
      SetAcknowledged = false,
      IncludeDomainDescriptions = true,
      IncludeGeometry = true,
      ServiceSynchronizationType = ServiceSynchronizationType.Asynchronous,

      SubnetworkExportResultTypes = new List<SubnetworkExportResultType>()
      {
        SubnetworkExportResultType.Connectivity,
        SubnetworkExportResultType.Features
      },

      ResultNetworkAttributes = new List<NetworkAttribute>(networkAttributes),

      ResultFieldsByNetworkSourceID = new Dictionary<int, List<string>>()
        { { networkSources[0].ID, new List<string>() { "OBJECTID" } } }
    };


    subnetwork.Export(exportResultJsonPath, subnetworkExportOptions);
  }
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.2 or higher.

Reference

Subnetwork Class
Subnetwork Members

Send feedback