com.esri.arcgis.geodatabase
Interface INetworkFeature

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ComplexEdgeFeature, ComplexJunctionFeature, INetworkFeatureProxy, SimpleEdgeFeature, SimpleJunctionFeature

public interface INetworkFeature

extends java.io.Serializable

Provides access to members that are common to all features in a GeometricNetwork.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

When To Use

Use the INetworkFeature interface to retrieve properties of a network feature.

Remarks

Features in a network can have one of four roles:

Simple Edge
Simple Junction
Complex Edge
Complex Junction

Method Summary

void	connect() Connect the Feature to the geometrically coincident NetworkFeature.
IEnumNetEID	createNetworkElements() Create the necessary NetworkElements in the associated Logical Network.
void	disconnect() Disconnect the Feature from all connected NetworkFeatures.
IGeometricNetwork	getGeometricNetwork() The containing GeometricNetwork.
boolean	isEnabled() Indicates whether the NetworkFeature is open or not (i.e., closed).
void	onDisconnect() Preparation for disconnecting the NetworkFeature.
void	setEnabled(boolean isEnabled) Indicates whether the NetworkFeature is open or not (i.e., closed).

Method Detail

getGeometricNetwork

public IGeometricNetwork getGeometricNetwork()
                                      throws java.io.IOException,
                                             AutomationException

The containing GeometricNetwork.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Indicates whether the NetworkFeature is open or not (i.e., closed).

Supported Platforms

Windows, Solaris, Linux

Remarks

The Enabled property provides access the enabled state of network features. The enabled state of network feature governs whether the feature is enabled or disabled for tracing. By default, all network features are enabled when the network is built or when first created.

All edits to features that participate in a Geometric Network must be performed within an edit session and bracketed within an edit operation.

Returns:

The isEnabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean isEnabled)
                throws java.io.IOException,
                       AutomationException

Indicates whether the NetworkFeature is open or not (i.e., closed).

Supported Platforms

Windows, Solaris, Linux

Parameters:

isEnabled - The isEnabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect()
             throws java.io.IOException,
                    AutomationException

Connect the Feature to the geometrically coincident NetworkFeature.

Supported Platforms

Windows, Solaris, Linux

Remarks

All edits to features that participate in a Geometric Network must be performed within an edit session and bracketed within an edit operation.

Looping through a collection or enumeration of junctions and calling Connect on each one to establish connectivity with a complex edge feature is an expensive operation. Calling IComplexEdgeFeature::ConnectatIntermediateVertices once on the complex edge feature will result in increased performance with the same resultant connectivity.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException

Disconnect the Feature from all connected NetworkFeatures.

Supported Platforms

Windows, Solaris, Linux

Remarks

All edits to features that participate in a Geometric Network must be performed within an edit session and bracketed within an edit operation.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDisconnect

public void onDisconnect()
                  throws java.io.IOException,
                         AutomationException

Preparation for disconnecting the NetworkFeature.

Supported Platforms

Windows, Solaris, Linux

Remarks

OnDisconnect is not currently implemented.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createNetworkElements

public IEnumNetEID createNetworkElements()
                                  throws java.io.IOException,
                                         AutomationException

Create the necessary NetworkElements in the associated Logical Network.

Supported Platforms

Windows, Solaris, Linux

Remarks

Every network feature in a geometric network has a corresponding network element in the logical network. CreateNetworkElements is called by the geometric network when network features are created. It is not neccessary for developers to call this method after creating new network features.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.