com.esri.arcgis.geodatabase
Interface INetworkClass

All Superinterfaces:

IClass, IFeatureClass, IObjectClass, Serializable

All Known Implementing Classes:

FeatureClass, INetworkClassProxy

public interface INetworkClass
extends IFeatureClass, Serializable

Provides access to members that return information about geometric networks, field weighting and ancillary roles.

Remarks

The FeatureType property of feature classes that implement this interface will be esriFTSimpleJunction, esriDTSimpleEdge, esriFTComplexJunction, or esriFTComplexEdge.

When To Use

Use the INetworkClass interface to get a reference to the geometric network which the network class (feature class) belongs to. You can also check to see if the network class has an Ancillary Role in the network, and the right to field mapping for the logical network.

The INetworkClass interface inherits from the IFeatureClass interface and the ITable interface.

Product Availability

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

Method Summary

int	getFieldToWeightMapping(int fieldIndex) The specified field to Weight mapping for the logical network.
IGeometricNetwork	getGeometricNetwork() The geometric network in which this class participates.
int	getNetworkAncillaryRole() The possible network ancillary roles of the contained Features.

Methods inherited from interface com.esri.arcgis.geodatabase.IFeatureClass

createFeature, createFeatureBuffer, featureCount, getAreaField, getFeature, getFeatureClassID, getFeatureDataset, getFeatures, getFeatureType, getLengthField, getShapeFieldName, getShapeType, IFeatureClass_insert, IFeatureClass_update, search, select

Methods inherited from interface com.esri.arcgis.geodatabase.IObjectClass

getAliasName, getObjectClassID, getRelationshipClasses

Methods inherited from interface com.esri.arcgis.geodatabase.IClass

addField, addIndex, deleteField, deleteIndex, findField, getCLSID, getEXTCLSID, getExtension, getExtensionProperties, getFields, getIndexes, getOIDFieldName, isHasOID

Method Detail

getGeometricNetwork

IGeometricNetwork getGeometricNetwork()
                                      throws IOException,
                                             AutomationException

The geometric network in which this class participates.

Remarks

The GeomtricNetwork property returns an IGeometricNetwork interface to the geometric network in which the network feature class participates.

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.

getFieldToWeightMapping

int getFieldToWeightMapping(int fieldIndex)
                            throws IOException,
                                   AutomationException

The specified field to Weight mapping for the logical network.

Product Availability

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

Parameters:

fieldIndex - The fieldIndex (in)

Returns:

The weightID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkAncillaryRole

int getNetworkAncillaryRole()
                            throws IOException,
                                   AutomationException

The possible network ancillary roles of the contained Features.

Remarks

The NetworkAncillaryRole property will return the esriNetworkAncillaryRole enumeration which indicates if the junction class has a network ancillary role. Since junctions in a geometric network can act as a source, a sink or neither when calculating flow direction, this property will indicate whether or not the features in the class can be sources or sinks. If the class is a simple edge or complex edge network class, the ancillary role will always be returned as esriNCARNone since only junctions may have ancillary roles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriNetworkClassAncillaryRole constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.