com.esri.arcgis.geodatabase
Interface IEnumNetEID

All Superinterfaces:

Serializable

All Known Implementing Classes:

EnumNetEIDArray

public interface IEnumNetEID
extends Serializable

Provides access to members that iterate through an enumeration of network element IDs (EIDs).

Remarks

The IEnumNetEID interface is returned by various methods on the logical network. It contains a set of EIDs from a given network. For example, calling the method INetwork::CreateNetBrowser returns a reference to the IEnumNetEID interface containing a set of EIDs based on the specified type of network element requested. INetElements::GetEIDs also returns an enumerator of this type.

Many of the trace tasks on the TraceFlowSolver object return this enumerator as well.

Product Availability

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

Method Summary

int	getCount() Number of network elements in this enumeration.
int	getElementType() Type of network elements in this enumeration.
INetwork	getNetwork() Network from which these elements came.
int	last() Forces the enumerator pointing at the last element in the enumeration and returns the last element.
int	next() Moves the enumerator forward and returns the network element pointed by the enumerator.
int	prev() Returns the network element pointed by the enumerator and moves the enumerator backward.
void	reset() Forces the enumerator pointing before first network element; a subsequent next gives the first network element in the enumeration.

Method Detail

getNetwork

INetwork getNetwork()
                    throws IOException,
                           AutomationException

Network from which these elements came.

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.INetwork

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of network elements in this enumeration.

Description

Returns the number of elements in the enumeration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementType

int getElementType()
                   throws IOException,
                          AutomationException

Type of network elements in this enumeration.

Remarks

The element type is a value from the esriElementType enumeration. Note that turns are only available for street networks and not utility networks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Forces the enumerator pointing before first network element; a subsequent next gives the first network element in the enumeration.

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.

next

int next()
         throws IOException,
                AutomationException

Moves the enumerator forward and returns the network element pointed by the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The eID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

last

int last()
         throws IOException,
                AutomationException

Forces the enumerator pointing at the last element in the enumeration and returns the last element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The eID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prev

int prev()
         throws IOException,
                AutomationException

Returns the network element pointed by the enumerator and moves the enumerator backward.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The eID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.