com.esri.arcgis.geodatabase
Interface INetElementDescription

All Superinterfaces:
Serializable
All Known Subinterfaces:
INetElementDescriptionEdit
All Known Implementing Classes:
NetElementDescription

public interface INetElementDescription
extends Serializable

Provides access to members that get information about the element described by this NetElementDescription object.

When To Use

The INetElementDescription interface provides methods for getting information pertaining to an element in your logical network. With this interface you can get such things as the UserClassID, UserID, and UserSubID of an element.

Each element in the network belongs to a feature in your feature dataset. The UserClassID is the ID of the feature class to which a particular network element belongs. The UserID is the ID of the feature within the feature class. The UserSubID is the ID of the individual element within the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
INetElementDescription, INetElementDescriptionEdit, INetElementClass, INetElements

Method Summary
 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.
 

Method Detail

getUserClassID

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

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

getUserID

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

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

getUserSubID

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

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

getElementType

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

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