com.esri.arcgis.geometry
Interface ISegmentGraphCursor

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISegmentGraphCursorProxy

public interface ISegmentGraphCursor
extends Serializable

Provides access to members that define and manipulate a way of navigating over segments topologically structured within a segment graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void finishMoveTo(IPoint newLocation)
          Moves from the current edge to the adjacent edge closest to newLocation.
 IPolyline getCurrentTrace()
          The current trace - a history of MoveTo/s and FinishMoveTo's within the segment graph since it was created or since the last call to Reset on this cursor.
 IPoint getLocation()
          The current location of the SegmentGraphCursor.
 boolean moveTo(IPoint newLocation)
          Moves from the current edge to an adjacent edge closest to newLocation.
 void queryLocation(IPoint currentGraphLocation)
          Copies the current location of the SegmentGraphCursor into the specified point.
 void reset(IPoint startPoint)
          Resets the location of the SegmentGraphCursor to a specified StartPoint.
 

Method Detail

getLocation

IPoint getLocation()
                   throws IOException,
                          AutomationException
The current location of the SegmentGraphCursor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocation

void queryLocation(IPoint currentGraphLocation)
                   throws IOException,
                          AutomationException
Copies the current location of the SegmentGraphCursor into the specified point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
currentGraphLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentTrace

IPolyline getCurrentTrace()
                          throws IOException,
                                 AutomationException
The current trace - a history of MoveTo/s and FinishMoveTo's within the segment graph since it was created or since the last call to Reset on this cursor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IPolyline
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveTo

boolean moveTo(IPoint newLocation)
               throws IOException,
                      AutomationException
Moves from the current edge to an adjacent edge closest to newLocation. Returns true when that move is clear, or false if it crosses a multi-way branch (in that case, then use FinishMoveTo).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
newLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
The canMove
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finishMoveTo

void finishMoveTo(IPoint newLocation)
                  throws IOException,
                         AutomationException
Moves from the current edge to the adjacent edge closest to newLocation. Used only when MoveTo returns false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
newLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset(IPoint startPoint)
           throws IOException,
                  AutomationException
Resets the location of the SegmentGraphCursor to a specified StartPoint.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
startPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.