com.esri.arcgis.geodatabase
Class IRasterCursorProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IRasterCursorProxy

All Implemented Interfaces:

IRasterCursor, Externalizable, Serializable

public class IRasterCursorProxy
extends com.esri.arcgis.interop.Dispatch
implements IRasterCursor, Serializable

Provides access to members that provide optimized raster access.

Remarks

The IRasterCursor interface controls enumeration through the PixelBlocks in a Raster. It is useful for rasters that are too large to be brought into memory at once.

The RasterCursor divides the Raster into blocks 128 pixels high that span the full width of the raster. Each successive PixelBlock is read 128 lines below the previous PixelBlock.

To create a RasterCursor, use the IRaster::CreateCursor or IRaster2::CreateCursorEx method.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IRasterCursorProxy()
	IRasterCursorProxy(Object obj)
protected	IRasterCursorProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IPixelBlock	getPixelBlock() The current PixelBlock.
IPnt	getTopLeft() The offset of the current PixelBlock.
boolean	next() Iterates to the next PixelBlock.
void	removeListener(String iidStr, Object theListener)
void	reset() Return to state when first created.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IRasterCursorProxy

public IRasterCursorProxy()

IRasterCursorProxy

public IRasterCursorProxy(Object obj)
                   throws IOException

Throws:

IOException

IRasterCursorProxy

protected IRasterCursorProxy(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

getTopLeft

public IPnt getTopLeft()
                throws IOException,
                       AutomationException

The offset of the current PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTopLeft in interface IRasterCursor

Returns:

A reference to a com.esri.arcgis.geodatabase.IPnt

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelBlock

public IPixelBlock getPixelBlock()
                          throws IOException,
                                 AutomationException

The current PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPixelBlock in interface IRasterCursor

Returns:

A reference to a com.esri.arcgis.geodatabase.IPixelBlock

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public boolean next()
             throws IOException,
                    AutomationException

Iterates to the next PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface IRasterCursor

Returns:

The not_finished

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Return to state when first created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IRasterCursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.