com.esri.arcgis.geodatabase
Interface IRasterCursor

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRasterCursorProxy, RasterCursor

public interface IRasterCursor
extends 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.

Method Summary

IPixelBlock	getPixelBlock() The current PixelBlock.
IPnt	getTopLeft() The offset of the current PixelBlock.
boolean	next() Iterates to the next PixelBlock.
void	reset() Return to state when first created.

Method Detail

getTopLeft

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

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

IPixelBlock getPixelBlock()
                          throws IOException,
                                 AutomationException

The current PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

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

Returns:

The not_finished

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.