com.esri.arcgis.geodatabase
Class NetElementDescription

java.lang.Object
  com.esri.arcgis.geodatabase.NetElementDescription

All Implemented Interfaces:

INetElementDescription, INetElementDescriptionEdit, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NetElementDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetElementDescription, INetElementDescriptionEdit

A container for describing an element in the network.

Remarks

NetElementDescription objects are used to add new elements to a logical network. The AddEdgeByEndEIDs and AddJunction methods on the INetTopologyEdit interface both take NetElementDescription objects as input for creating new elements.

You should only be adding new elements to logical networks that do not have associated geometric networks. For geometric networks, simply add new features--new elements will automatically be added when you add the new features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

NetElementDescription()
Constructs a NetElementDescription using ArcGIS Engine.

NetElementDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetElementDescription theNetElementDescription = (NetElementDescription) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getElementType() Type of network element described by this NetElementDescription object.
int	getUserClassID() User class ID for the element described by this NetElementDescription object.
int	getUserID() User ID for the element described by this NetElementDescription object.
int	getUserSubID() User sub ID for the element described by this NetElementDescription object.
int	hashCode() the hashcode for this object
void	setElementType(int rhs1) Type of network element for this NetElementDescription object.
void	setUserClassID(int rhs1) User class ID for this NetElementDescription object.
void	setUserID(int rhs1) User ID for this NetElementDescription object.
void	setUserSubID(int rhs1) User sub ID for this NetElementDescription object.

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

NetElementDescription

public NetElementDescription()
                      throws IOException,
                             UnknownHostException

Constructs a NetElementDescription using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NetElementDescription

public NetElementDescription(Object obj)
                      throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetElementDescription theNetElementDescription = (NetElementDescription) obj;

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

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

getUserClassID

public int getUserClassID()
                   throws IOException,
                          AutomationException

User class ID for the element described by this NetElementDescription object.

Remarks

UserClassID returns the object class ID of the element. Use INetElementDescriptionEdit to update the value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserClassID in interface INetElementDescription

Returns:

The elementclassUserID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserID

public int getUserID()
              throws IOException,
                     AutomationException

User ID for the element described by this NetElementDescription object.

Remarks

UserID returns the object ID (OID) of the element. Use INetElementDescriptionEdit to update the value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserID in interface INetElementDescription

Returns:

The userID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserSubID

public int getUserSubID()
                 throws IOException,
                        AutomationException

User sub ID for the element described by this NetElementDescription object.

Remarks

UserSubID returns the index number of the element within the feature. Use INetElementDescriptionEdit to update the value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserSubID in interface INetElementDescription

Returns:

The userSubID

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 element described by this NetElementDescription object.

Remarks

ElementType returns the type of the element. The possible types are esriETEdge (value of 2), esriETJunction (value of 1), esriETNone (value of 0), and esriETTurn (value of 3).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElementType in interface INetElementDescription

Returns:

A com.esri.arcgis.geodatabase.esriElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserClassID

public void setUserClassID(int rhs1)
                    throws IOException,
                           AutomationException

User class ID for this NetElementDescription object.

Remarks

UserClassID allows setting and retrieval of the object class ID of the element. Use INetElementDescription for read-only access.

The UserClassID must be a positive integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserClassID in interface INetElementDescriptionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserID

public void setUserID(int rhs1)
               throws IOException,
                      AutomationException

User ID for this NetElementDescription object.

Remarks

UserID allows setting and retrieval of the object ID (OID) of the element. Use INetElementDescription for read-only access.

The UserID must be a positive integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserID in interface INetElementDescriptionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserSubID

public void setUserSubID(int rhs1)
                  throws IOException,
                         AutomationException

User sub ID for this NetElementDescription object.

Remarks

UserSubID allows setting and retrieval of the sub ID of the element within the feature. Use INetElementDescription for read-only access.

The UserSubID must be a non-negative integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserSubID in interface INetElementDescriptionEdit

Parameters:

rhs1 - The rhs1 (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 element for this NetElementDescription object.

Remarks

ElementType return or sets the type of the element. The possible types are esriETEdge (value of 2), esriETJunction (value of 1), esriETNone (value of 0), and esriETTurn (value of 3).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setElementType in interface INetElementDescriptionEdit

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.