com.esri.arcgis.geodatabase
Interface INetworkFeature

All Superinterfaces:
Serializable
All Known Implementing Classes:
ComplexEdgeFeature, ComplexJunctionFeature, SimpleEdgeFeature, SimpleJunctionFeature

public interface INetworkFeature
extends Serializable

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

Remarks

Features in a network can have one of four roles:

Simple Edge
Simple Junction
Complex Edge
Complex Junction

When To Use

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IComplexNetworkFeature, IJunctionFeature, INetworkFeature.connect(), IEdgeFeature, IComplexJunctionFeature, IComplexEdgeFeature, INetworkFeatureEvents, ISimpleJunctionFeature, ISimpleEdgeFeature, INetworkFeature

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

IGeometricNetwork getGeometricNetwork()
                                      throws IOException,
                                             AutomationException
The containing GeometricNetwork.

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.IGeometricNetwork
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException
Indicates whether the NetworkFeature is open or not (i.e., closed).

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The isEnabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(boolean isEnabled)
                throws IOException,
                       AutomationException
Indicates whether the NetworkFeature is open or not (i.e., closed).

Example:

//Assume you already have a reference to IFeature called pFeature
INetworkFeature pNetworkFeature = pFeature;

if(pNetworkFeature != null){

if(pNetworkFeature.isEnabled )
pNetworkFeature.setEnabled (false);
else
pNetworkFeature.setEnabled (true);
}
pFeature.store();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
isEnabled - The isEnabled (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

void connect()
             throws IOException,
                    AutomationException
Connect the Feature to the geometrically coincident NetworkFeature.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IComplexEdgeFeature.connectAtIntermediateVertices()

disconnect

void disconnect()
                throws IOException,
                       AutomationException
Disconnect the Feature from all connected NetworkFeatures.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onDisconnect

void onDisconnect()
                  throws IOException,
                         AutomationException
Preparation for disconnecting the NetworkFeature.

Remarks

OnDisconnect is not currently implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createNetworkElements

IEnumNetEID createNetworkElements()
                                  throws IOException,
                                         AutomationException
Create the necessary NetworkElements in the associated Logical Network.

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.

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.IEnumNetEID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.