com.esri.arcgis.geodatabase
Interface IForwardStarGEN

All Superinterfaces:
Serializable
All Known Implementing Classes:
ForwardStar, IForwardStarGENProxy

public interface IForwardStarGEN
extends Serializable

Provides access to members that query information about adjacent elements in the logical network.

Product Availability

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


Method Summary
 void findAdjacent(int fromEdgeEID, int atJunctionEID, int[] adjacentEdgesCount)
          Finds the edge elements that are adjacent to the given junction element and returns the count.
 INetwork getNetwork()
          Underlying network of this forward star cursor.
 void queryAdjacentEdge(int index, int[] adjacentEdgeEID, boolean[] reverseOrientation, Object[] adjacentEdgeWeightValue)
          Returns index'th adjacent edge found with FindAdjacent, its orientation, and its weight value.
 void queryAdjacentEdges(int[][] adjacentEdgeEIDs, boolean[][] reverseOrientation, Object[][] adjacentEdgesWeightValue)
          Returns the adjacent edges found with FindAdjacent into the specified user-defined array.
 void queryAdjacentJunction(int index, int[] adjacentJunctionEID, Object[] adjacentJunctionWeightValue)
          Returns the opposite junction of the index'th adjacent edge found with FindAdjacent, and the weight value for this junction.
 void queryAdjacentJunctions(int[][] adjacentJunctionEIDs, Object[][] adjacentJunctionsWeightValue)
          Returns the opposite junctions of the adjacent edges found with FindAdjacent into the specified user-defined array.
 void queryAtTurn(int index, int[] adjacentTurnEID, Object[] adjacentTurnWeightValue)
          Returns the turn through which the index'th adjacent edge found with FindAdjacent passes, and the weight value of the turn.
 

Method Detail

getNetwork

INetwork getNetwork()
                    throws IOException,
                           AutomationException
Underlying network of this forward star cursor.

Product Availability

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

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.

findAdjacent

void findAdjacent(int fromEdgeEID,
                  int atJunctionEID,
                  int[] adjacentEdgesCount)
                  throws IOException,
                         AutomationException
Finds the edge elements that are adjacent to the given junction element and returns the count.

Product Availability

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

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

queryAdjacentJunction

void queryAdjacentJunction(int index,
                           int[] adjacentJunctionEID,
                           Object[] adjacentJunctionWeightValue)
                           throws IOException,
                                  AutomationException
Returns the opposite junction of the index'th adjacent edge found with FindAdjacent, and the weight value for this junction.

Product Availability

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

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

queryAdjacentEdge

void queryAdjacentEdge(int index,
                       int[] adjacentEdgeEID,
                       boolean[] reverseOrientation,
                       Object[] adjacentEdgeWeightValue)
                       throws IOException,
                              AutomationException
Returns index'th adjacent edge found with FindAdjacent, its orientation, and its weight value.

Product Availability

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

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

queryAtTurn

void queryAtTurn(int index,
                 int[] adjacentTurnEID,
                 Object[] adjacentTurnWeightValue)
                 throws IOException,
                        AutomationException
Returns the turn through which the index'th adjacent edge found with FindAdjacent passes, and the weight value of the turn.

Product Availability

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

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

queryAdjacentJunctions

void queryAdjacentJunctions(int[][] adjacentJunctionEIDs,
                            Object[][] adjacentJunctionsWeightValue)
                            throws IOException,
                                   AutomationException
Returns the opposite junctions of the adjacent edges found with FindAdjacent into the specified user-defined array.

Product Availability

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

Parameters:
adjacentJunctionEIDs - The adjacentJunctionEIDs (in/out: use single element array)
adjacentJunctionsWeightValue - A Variant (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAdjacentEdges

void queryAdjacentEdges(int[][] adjacentEdgeEIDs,
                        boolean[][] reverseOrientation,
                        Object[][] adjacentEdgesWeightValue)
                        throws IOException,
                               AutomationException
Returns the adjacent edges found with FindAdjacent into the specified user-defined array.

Product Availability

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

Parameters:
adjacentEdgeEIDs - The adjacentEdgeEIDs (in/out: use single element array)
reverseOrientation - The reverseOrientation (in/out: use single element array)
adjacentEdgesWeightValue - A Variant (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.