com.esri.arcgis.geodatabase
Interface IEdgeConnectivityRule

All Superinterfaces:
IConnectivityRule, IRule, Serializable
All Known Implementing Classes:
EdgeConnectivityRule

public interface IEdgeConnectivityRule
extends IConnectivityRule, Serializable

Provides access to members that supply information about, modify and manage edge-edge connectivity rules.

Description

IEdgeConnectivityRule interface provides properties for setting up a edge connectivity rule.

When To Use

The IEdgeConnectivityRule is the main interface for creating and getting information about an edge connectivity rule. Use this interface to create a new edge connectivity rule between subtypes in an edge network feature class and subtypes in another edge network feature class. This interface also allows you to specify all of the valid junction subtypes that the edge subtypes can connect through and allows you to set the default junction subtype.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addJunction(int classID, int subtypeCode)
          The permissible values for the associated attribute.
 boolean containsJunction(int classID, int subtypeCode)
          Indicates whether the specified junction class id is in the valid junction list.
 int getDefaultJunctionClassID()
          The ID of the default junction feature class.
 int getDefaultJunctionSubtypeCode()
          The subtype value of the default junction feature class.
 int getFromEdgeClassID()
          The ID of the source NetworkEdge feature class.
 int getFromEdgeSubtypeCode()
          The subtype value of the source NetworkEdge feature class.
 int getJunctionClassID(int index)
          The specified permissible value for the associated attribute.
 int getJunctionCount()
          The number of valid Junctions.
 void getJunctionInfo(int index, int[] classID, int[] subtypeCode)
          The specified permissible value for the associated attribute.
 int getJunctionSubtypeCode(int index)
          The specified permissible value for the associated attribute.
 int getToEdgeClassID()
          The ID of the destination NetworkEdge feature class.
 int getToEdgeSubtypeCode()
          The subtype value of the target NetworkEdge feature class.
 void setDefaultJunctionClassID(int classID)
          The ID of the default junction feature class.
 void setDefaultJunctionSubtypeCode(int value)
          The subtype value of the default junction feature class.
 void setFromEdgeClassID(int classID)
          The ID of the source NetworkEdge feature class.
 void setFromEdgeSubtypeCode(int value)
          The subtype value of the source NetworkEdge feature class.
 void setToEdgeClassID(int classID)
          The ID of the destination NetworkEdge feature class.
 void setToEdgeSubtypeCode(int value)
          The subtype value of the target NetworkEdge feature class.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IRule
getCategory, getHelpstring, getID, getType, setCategory, setHelpstring, setID
 

Method Detail

getDefaultJunctionClassID

int getDefaultJunctionClassID()
                              throws IOException,
                                     AutomationException
The ID of the default junction feature class.

Description

DefaultJunctionClassID property returns the class id for the default junction that has been set for this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultJunctionClassID

void setDefaultJunctionClassID(int classID)
                               throws IOException,
                                      AutomationException
The ID of the default junction feature class.

Description

DefaultJunctionClassID property sets the class id for the default junction to be used for edge connectivity rules.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultJunctionSubtypeCode

int getDefaultJunctionSubtypeCode()
                                  throws IOException,
                                         AutomationException
The subtype value of the default junction feature class.

Description

DefaultJunctionSubtypeCode property returns the subtype code for the default junction type that has been set for this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultJunctionSubtypeCode

void setDefaultJunctionSubtypeCode(int value)
                                   throws IOException,
                                          AutomationException
The subtype value of the default junction feature class.

Description

DefaultJunctionSubtypeCode property sets the subtype code that is to be used as the default junction subtype for this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFromEdgeClassID

int getFromEdgeClassID()
                       throws IOException,
                              AutomationException
The ID of the source NetworkEdge feature class.

Description

FromEdgeClassID property returns the class id for the from edge type of this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFromEdgeClassID

void setFromEdgeClassID(int classID)
                        throws IOException,
                               AutomationException
The ID of the source NetworkEdge feature class.

Description

FromEdgeClassID property sets the class id for the from edge type that this edge connectivity rule will apply to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFromEdgeSubtypeCode

int getFromEdgeSubtypeCode()
                           throws IOException,
                                  AutomationException
The subtype value of the source NetworkEdge feature class.

Description

FromEdgeSubtypeCode property returns the subtype code for the from edge of this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFromEdgeSubtypeCode

void setFromEdgeSubtypeCode(int value)
                            throws IOException,
                                   AutomationException
The subtype value of the source NetworkEdge feature class.

Description

FromEdgeSubtypeCode property sets the subtype code for the from edge of this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getToEdgeClassID

int getToEdgeClassID()
                     throws IOException,
                            AutomationException
The ID of the destination NetworkEdge feature class.

Description

ToEdgeClassID property returns the class id for the "to edge" that this edge connectivity rule applies to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setToEdgeClassID

void setToEdgeClassID(int classID)
                      throws IOException,
                             AutomationException
The ID of the destination NetworkEdge feature class.

Description

ToEdgeClassID property sets the class id for the "to edge" that this edge connectivity rule applies to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getToEdgeSubtypeCode

int getToEdgeSubtypeCode()
                         throws IOException,
                                AutomationException
The subtype value of the target NetworkEdge feature class.

Description

ToEdgeSubtypeCode property returns the subtype code for the "to edge" that this edge connectivity rule applies to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setToEdgeSubtypeCode

void setToEdgeSubtypeCode(int value)
                          throws IOException,
                                 AutomationException
The subtype value of the target NetworkEdge feature class.

Description

ToEdgeSubtypeCode property sets the subtype code for the "to edge" that this edge connectivity rule applies to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getJunctionCount

int getJunctionCount()
                     throws IOException,
                            AutomationException
The number of valid Junctions.

Description

JunctionCount returns the junction count.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getJunctionClassID

int getJunctionClassID(int index)
                       throws IOException,
                              AutomationException
The specified permissible value for the associated attribute.

Product Availability

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

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

getJunctionSubtypeCode

int getJunctionSubtypeCode(int index)
                           throws IOException,
                                  AutomationException
The specified permissible value for the associated attribute.

Product Availability

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

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

addJunction

void addJunction(int classID,
                 int subtypeCode)
                 throws IOException,
                        AutomationException
The permissible values for the associated attribute.

Description

AddJunction function adds an allowable junction for this edge connectivity rule that has the classid and subtypecode specified in the parameters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

containsJunction

boolean containsJunction(int classID,
                         int subtypeCode)
                         throws IOException,
                                AutomationException
Indicates whether the specified junction class id is in the valid junction list.

Description

ContainsJunction function takes the class id and subtype code of a junction feature as parameters and returns a boolean value of whether or not it is contained in the set of valid junctions for this edge connectivity rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getJunctionInfo

void getJunctionInfo(int index,
                     int[] classID,
                     int[] subtypeCode)
                     throws IOException,
                            AutomationException
The specified permissible value for the associated attribute.

Description

GetJunctionInfo function returns the class id and the subtype code for the particular junction that is referenced by the index parameter passed in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
classID - The classID (out: use single element array)
subtypeCode - The subtypeCode (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.