com.esri.arcgis.geodatabase
Class EnumNetEIDArray

java.lang.Object
  extended by com.esri.arcgis.geodatabase.EnumNetEIDArray
All Implemented Interfaces:
IEnumNetEID, IEnumNetEIDBuilder, IEnumNetEIDBuilderGEN, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class EnumNetEIDArray
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEnumNetEID, IEnumNetEIDBuilderGEN, IEnumNetEIDBuilder

A container for defining a network element ID (EID) enumeration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
EnumNetEIDArray()
          Constructs a EnumNetEIDArray using ArcGIS Engine.
EnumNetEIDArray(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EnumNetEIDArray theEnumNetEIDArray = (EnumNetEIDArray) obj;
 
Method Summary
 void add(int eID)
          Adds an element to this EID enumeration.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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 hashCode()
          the hashcode for this object
 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.
 void setEIDs(int[] rhs1)
          Array of EIDs in this enumeration.
 void setEIDs(int count, int[] rhs2)
          Array of EIDs in this enumeration.
 void setElementType(int rhs1)
          Type of network elements to be in this enumeration.
 void setNetworkByRef(INetwork rhs1)
          Network from which these elements came.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

EnumNetEIDArray

public EnumNetEIDArray()
                throws IOException,
                       UnknownHostException
Constructs a EnumNetEIDArray using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

EnumNetEIDArray

public EnumNetEIDArray(Object obj)
                throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EnumNetEIDArray theEnumNetEIDArray = (EnumNetEIDArray) obj;

Construct a EnumNetEIDArray using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EnumNetEIDArray.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getNetwork

public 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

Specified by:
getNetwork in interface IEnumNetEID
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

public 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

Specified by:
getCount in interface IEnumNetEID
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementType

public 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

Specified by:
getElementType in interface IEnumNetEID
Returns:
A com.esri.arcgis.geodatabase.esriElementType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public 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

Specified by:
reset in interface IEnumNetEID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

public 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

Specified by:
next in interface IEnumNetEID
Returns:
The eID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

last

public 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

Specified by:
last in interface IEnumNetEID
Returns:
The eID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

prev

public 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

Specified by:
prev in interface IEnumNetEID
Returns:
The eID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNetworkByRef

public void setNetworkByRef(INetwork rhs1)
                     throws IOException,
                            AutomationException
Network from which these elements came.

Product Availability

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

Specified by:
setNetworkByRef in interface IEnumNetEIDBuilder
Specified by:
setNetworkByRef in interface IEnumNetEIDBuilderGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetwork (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(int eID)
         throws IOException,
                AutomationException
Adds an element to this EID enumeration.

Product Availability

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

Specified by:
add in interface IEnumNetEIDBuilder
Specified by:
add in interface IEnumNetEIDBuilderGEN
Parameters:
eID - The eID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElementType

public void setElementType(int rhs1)
                    throws IOException,
                           AutomationException
Type of network elements to be in this enumeration.

Product Availability

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

Specified by:
setElementType in interface IEnumNetEIDBuilder
Specified by:
setElementType in interface IEnumNetEIDBuilderGEN
Parameters:
rhs1 - A com.esri.arcgis.geodatabase.esriElementType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEIDs

public void setEIDs(int[] rhs1)
             throws IOException,
                    AutomationException
Array of EIDs in this enumeration.

Product Availability

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

Specified by:
setEIDs in interface IEnumNetEIDBuilderGEN
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEIDs

public void setEIDs(int count,
                    int[] rhs2)
             throws IOException,
                    AutomationException
Array of EIDs in this enumeration.

Product Availability

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

Specified by:
setEIDs in interface IEnumNetEIDBuilder
Parameters:
count - The count (in)
rhs2 - The rhs2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.