com.esri.arcgis.geodatabase
Interface INetElementDescriptionEdit

All Superinterfaces:
INetElementDescription, Serializable
All Known Implementing Classes:
NetElementDescription

public interface INetElementDescriptionEdit
extends INetElementDescription, Serializable

Provides access to members that set information for this NetElementDescription object.

When To Use

When building a logical network you need to create individual network elements before adding them to the network. Through this interface you can specify the UserClassID, UserID, and UserSubID of an individual element.

The NetElementDescriptionEdit object you populate can then be added to your logical network through the INetTopologyEdit interface.

This should only be used for adding elements to a logical network that does not have an associated geometric network. In the case of a geometric network you are adding features and not network elements. The logical network automatically takes care of adding the network elements when you create a new feature.

Product Availability

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

See Also:
INetElementDescription, INetElementDescriptionEdit, INetElementClass, INetElements

Method Summary
 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 interface com.esri.arcgis.geodatabase.INetElementDescription
getElementType, getUserClassID, getUserID, getUserSubID
 

Method Detail

setUserClassID

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

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

setUserID

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

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

setUserSubID

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

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

setElementType

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

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.