com.esri.arcgis.datasourcesraster
Class PixelBlockCursor

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.PixelBlockCursor
All Implemented Interfaces:
IPixelBlockCursor, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class PixelBlockCursor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelBlockCursor

COM Class 'PixelBlockCursor'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'A PixelBlock cursor class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelBlockCursor
IID, IID54dfc56a_bc14_46ac_a815_07dea8cb9cfb, xxDummy
 
Constructor Summary
PixelBlockCursor()
          Constructs a PixelBlockCursor using ArcGIS Engine.
PixelBlockCursor(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PixelBlockCursor thePixelBlockCursor = (PixelBlockCursor) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 void getBlockSize(int[] pBlockSizeX, int[] pBlockSizeY)
          Gets the cursor block size.
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int hashCode()
          the hashcode for this object
 void initByRaster(IRaster pRaster)
          Initializes the cursor by the raster interface.
 void initByRawPixels(IRawPixels pRowPixels, int blockSizeX, int blockSizeY)
          Initializes the cursor by the raw pixel interface.
 IPixelBlock nextBlock(int[] pLeft, int[] pTop, int[] pSizeX, int[] pSizeY)
          Obtains the next pixel block from the cursor.
 void release()
          Release a PixelBlockCursor.
 void setScanMode(int rhs1)
          The cursor scan mode: Line = 0, LineSerpent = 1, Serpent2 = 3, alaGIF = 4.
 void updateBlockSize(int blockSizeX, int blockSizeY)
          Updates the cursor block size.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PixelBlockCursor

public PixelBlockCursor()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a PixelBlockCursor using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

PixelBlockCursor

public PixelBlockCursor(java.lang.Object obj)
                 throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PixelBlockCursor thePixelBlockCursor = (PixelBlockCursor) obj;

Construct a PixelBlockCursor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PixelBlockCursor.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a PixelBlockCursor.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

initByRawPixels

public void initByRawPixels(IRawPixels pRowPixels,
                            int blockSizeX,
                            int blockSizeY)
                     throws java.io.IOException,
                            AutomationException
Initializes the cursor by the raw pixel interface.

Specified by:
initByRawPixels in interface IPixelBlockCursor
Parameters:
pRowPixels - A reference to a com.esri.arcgis.datasourcesraster.IRawPixels (in)
blockSizeX - The blockSizeX (in)
blockSizeY - The blockSizeY (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initByRaster

public void initByRaster(IRaster pRaster)
                  throws java.io.IOException,
                         AutomationException
Initializes the cursor by the raster interface.

Specified by:
initByRaster in interface IPixelBlockCursor
Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateBlockSize

public void updateBlockSize(int blockSizeX,
                            int blockSizeY)
                     throws java.io.IOException,
                            AutomationException
Updates the cursor block size.

Specified by:
updateBlockSize in interface IPixelBlockCursor
Parameters:
blockSizeX - The blockSizeX (in)
blockSizeY - The blockSizeY (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlockSize

public void getBlockSize(int[] pBlockSizeX,
                         int[] pBlockSizeY)
                  throws java.io.IOException,
                         AutomationException
Gets the cursor block size.

Specified by:
getBlockSize in interface IPixelBlockCursor
Parameters:
pBlockSizeX - The pBlockSizeX (in/out: use single element array)
pBlockSizeY - The pBlockSizeY (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScanMode

public void setScanMode(int rhs1)
                 throws java.io.IOException,
                        AutomationException
The cursor scan mode: Line = 0, LineSerpent = 1, Serpent2 = 3, alaGIF = 4.

Specified by:
setScanMode in interface IPixelBlockCursor
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextBlock

public IPixelBlock nextBlock(int[] pLeft,
                             int[] pTop,
                             int[] pSizeX,
                             int[] pSizeY)
                      throws java.io.IOException,
                             AutomationException
Obtains the next pixel block from the cursor.

Specified by:
nextBlock in interface IPixelBlockCursor
Parameters:
pLeft - The pLeft (in/out: use single element array)
pTop - The pTop (in/out: use single element array)
pSizeX - The pSizeX (in/out: use single element array)
pSizeY - The pSizeY (in/out: use single element array)
Returns:
A reference to a com.esri.arcgis.geodatabase.IPixelBlock
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.