com.esri.arcgis.geodatabase
Interface IGeometricNetworkErrorDetection

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeometricNetwork, IGeometricNetworkErrorDetectionProxy

public interface IGeometricNetworkErrorDetection
extends Serializable

Provides access to members that manage and provide geometric network error detection.

Description

The IGeometricNetworkErrorDetection interface identifies errors between a geometric network and its logical network. In order to maintain correct network connectivity in large production environments, it is necessary to have a collection of tools that will enable the user to detect a variety of connectivity problems within a geometric network. In production environments, it is often impractical to drop the network and rebuild when connectivity problems are encountered during general editing of the network. For this reason, it is necessary to provide a set of tools that will enable the end user to detect and repair such problems.

Philosophically, there should not be any need for such tools—the network should always be correct. From this standpoint, the geodatabase will not waver. However, there are certain circumstances where this may
be violated:

• The end user attempts to build a geometric network from data that has illegal geometry.
• Logic errors in the software implementation (as the software matures, this will become less and less likely).
• Applications or tools that do not correctly abort edit operations that the geometric network returns as an error.
• Third-party tools that attempt to manipulate the geometric network at a low level (for example, at the logical network level) and have logic errors in their software implementation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	createErrorTable(String name, ITable[] errorTable) Creates a non-versioned table that can be used to persist error information.
ISet	createSelectionSetFromErrorTable() Returns a set of selection sets of the features in the geometric network Error Table.
void	deleteNetworkElements(ISet selectionSets) Deletes the network elements associated with the specified network features.
void	detectNetworkErrors(int errorType, IEnvelope areaOfInterest, ISet selectionSets, ISet[] problemSelectionSets) The features in the geometric network with connectivity problems.
ITable	getErrorTable() The error table currently associated with the geometric network.
void	setErrorTable(ITable errorTable) The error table currently associated with the geometric network.

Method Detail

getErrorTable

ITable getErrorTable()
                     throws IOException,
                            AutomationException

The error table currently associated with the geometric network. This property will return nothing unless it has been set within the running application.

Description

The ErrorTable property provides the ability to either return the error table if it exists or associate an error table with the geometric network, after it has been created with the IGeometricNetworkErrorDetection::CreateErrorTable method. Once the error table is created, it can be associated with, or retrieved from, a geometric network. However, this association will not be persisted—the association is only for the lifetime of the geometric network component instance. The user is responsible for managing this error table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorTable

void setErrorTable(ITable errorTable)
                   throws IOException,
                          AutomationException

The error table currently associated with the geometric network. This property will return nothing unless it has been set within the running application.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

errorTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSelectionSetFromErrorTable

ISet createSelectionSetFromErrorTable()
                                      throws IOException,
                                             AutomationException

Returns a set of selection sets of the features in the geometric network Error Table.

Description

A set of selection sets may be created from all the entries found in the error table that are currently associated with a geometric network via the CreateSelectionSetFromErrorTable method. This is a mechanism that can be used to create instances of the network features that are listed in the error table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createErrorTable

void createErrorTable(String name,
                      ITable[] errorTable)
                      throws IOException,
                             AutomationException

Creates a non-versioned table that can be used to persist error information.

Description

The CreateErrorTable method is used to create a table that can be used to persist information related to inconsistent network features (using a fixed table schema) with the specified name. Such network error information can only be persisted by the geometric network in a table with this schema. This table is user managed and should remain unversioned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

errorTable - A reference to a com.esri.arcgis.geodatabase.ITable (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detectNetworkErrors

void detectNetworkErrors(int errorType,
                         IEnvelope areaOfInterest,
                         ISet selectionSets,
                         ISet[] problemSelectionSets)
                         throws IOException,
                                AutomationException

The features in the geometric network with connectivity problems.

Description

The DetectNetworkErrors method is used to detect the different possible types of network connectivity and geometry problems. While the DetectNetworkErrors method will discover network features with inconsistent connectivity, it does not perform an exhaustive verification. The IGeometricNetworkConnectivity2::CheckandRepairConnectivity method performs a more exhaustive check for network inconsistencies.

The DetectNetworkErrors method takes a number of arguements, the first being the type of network error to detect. This arguement corresponds with a value from the esriNetworkErrorType enumeration. Use esriNETConnectivity to verify network connectivity and esriNETGeometry to verify network feature geometry.

The second argument is an IEnvelope object defining the area of interest, any feature within or intersecting the envelope will be verified. The third arguement is a selection set of features. If Nothing is supplied for an area of interest, the features in the selection set will be verified. Finally, any features identified as invalid will be returned in a selection set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

errorType - A com.esri.arcgis.geodatabase.esriNetworkErrorType constant (in)

areaOfInterest - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

selectionSets - A reference to a com.esri.arcgis.system.ISet (in)

problemSelectionSets - A reference to a com.esri.arcgis.system.ISet (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteNetworkElements

void deleteNetworkElements(ISet selectionSets)
                           throws IOException,
                                  AutomationException

Deletes the network elements associated with the specified network features.

Description

The DeleteNetworkElements method takes an ISet of ISelectionSets. All of the network features contained in the various selection sets will have their network elements deleted from the logical network. The primary reason why one would want to do this is to correct the geometry of an edge feature that was loaded with invalid polyline geometry. This method should be called on valid network features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

selectionSets - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.