com.esri.arcgis.geometry
Class ISegmentGraphCursorProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geometry.ISegmentGraphCursorProxy
All Implemented Interfaces:
ISegmentGraphCursor, Externalizable, Serializable

public class ISegmentGraphCursorProxy
extends com.esri.arcgis.interop.Dispatch
implements ISegmentGraphCursor, 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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ISegmentGraphCursorProxy()
           
  ISegmentGraphCursorProxy(Object obj)
           
protected ISegmentGraphCursorProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void reset(IPoint startPoint)
          Resets the location of the SegmentGraphCursor to a specified StartPoint.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ISegmentGraphCursorProxy

public ISegmentGraphCursorProxy()

ISegmentGraphCursorProxy

public ISegmentGraphCursorProxy(Object obj)
                         throws IOException
Throws:
IOException

ISegmentGraphCursorProxy

protected ISegmentGraphCursorProxy(Object obj,
                                   String iid)
                            throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getLocation

public 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

Specified by:
getLocation in interface ISegmentGraphCursor
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

public 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

Specified by:
queryLocation in interface ISegmentGraphCursor
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

public 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

Specified by:
getCurrentTrace in interface ISegmentGraphCursor
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

public 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

Specified by:
moveTo in interface ISegmentGraphCursor
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

public 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

Specified by:
finishMoveTo in interface ISegmentGraphCursor
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

public 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

Specified by:
reset in interface ISegmentGraphCursor
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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException