com.esri.arcgis.datasourcesraster
Class IPixelBlock3Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.datasourcesraster.IPixelBlock3Proxy
All Implemented Interfaces:
IPixelBlock3, Externalizable, Serializable

public class IPixelBlock3Proxy
extends com.esri.arcgis.interop.Dispatch
implements IPixelBlock3, Serializable

Provides access to members that control a PixelBlock.

Description

The IPixelBlock3 interface provides all the functionality of IPixelBlock interface, plus more properties on mask based NoData and SafeArray handling.

Basically, there are two ways to work with NoData mask and pixel values. They are by value (PixelData and NoDataMask properties) and by reference (PixelDataByRef and NoDataMaskByRef). Normally passing pixel values by reference is recommented since it saves memory. However for Java and .Net, passing by value (PixelData) should be used.

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
  IPixelBlock3Proxy()
           
  IPixelBlock3Proxy(Object obj)
           
protected IPixelBlock3Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void clear(int plane)
          Clears a given plane (sets to NoData).
 int getBytesPerPixel()
          The number of bytes per pixel for the PixelBlock.
 int getHeight()
          The height of the PixelBlock in pixels.
 Object getNoDataMask(int plane)
          The NoData mask for a specified plane.
 Object getNoDataMaskByRef(int plane)
          The NoData mask for a specified plane.
 Object getNoDataMaskVal(int plane, int x, int y)
          Gets the NoData mask value for a specified pixel.
 Object getPixelData(int plane)
          An array of pixels for a specified plane.
 Object getPixelDataByRef(int plane)
          A pointer to an array of pixels for a specified plane.
 int getPixelType(int plane)
          The pixel type of the PixelBlock.
 int getPlanes()
          The number of pixel arrays contained in the PixelBlock.
 Object getVal(int plane, int x, int y)
          The value for a specified pixel.
 int getWidth()
          The width of the PixelBlock in pixels.
 boolean hasNoData(int plane)
          Checks if this PixelBlock contains NoData.
 void mask(Object noData)
          Generates NoData Mask using a given NoData value.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setNoDataMask(int plane, Object pVal)
          The NoData mask for a specified plane.
 void setPixelData(int plane, Object pVal)
          An array of pixels for a specified plane.
 void setPixelType(int plane, int pVal)
          The pixel type of the PixelBlock.
 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

IPixelBlock3Proxy

public IPixelBlock3Proxy()

IPixelBlock3Proxy

public IPixelBlock3Proxy(Object obj)
                  throws IOException
Throws:
IOException

IPixelBlock3Proxy

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

getPlanes

public int getPlanes()
              throws IOException,
                     AutomationException
The number of pixel arrays contained in the PixelBlock.

Remarks

The Planes property returns the number of bands in the PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPlanes in interface IPixelBlock3
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException
The width of the PixelBlock in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWidth in interface IPixelBlock3
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException
The height of the PixelBlock in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHeight in interface IPixelBlock3
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType(int plane)
                 throws IOException,
                        AutomationException
The pixel type of the PixelBlock.

Product Availability

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

Specified by:
getPixelType in interface IPixelBlock3
Parameters:
plane - The plane (in)
Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int plane,
                         int pVal)
                  throws IOException,
                         AutomationException
The pixel type of the PixelBlock.

Product Availability

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

Specified by:
setPixelType in interface IPixelBlock3
Parameters:
plane - The plane (in)
pVal - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBytesPerPixel

public int getBytesPerPixel()
                     throws IOException,
                            AutomationException
The number of bytes per pixel for the PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBytesPerPixel in interface IPixelBlock3
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelData

public Object getPixelData(int plane)
                    throws IOException,
                           AutomationException
An array of pixels for a specified plane.

Product Availability

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

Specified by:
getPixelData in interface IPixelBlock3
Parameters:
plane - The plane (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelData

public void setPixelData(int plane,
                         Object pVal)
                  throws IOException,
                         AutomationException
An array of pixels for a specified plane.

Product Availability

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

Specified by:
setPixelData in interface IPixelBlock3
Parameters:
plane - The plane (in)
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelDataByRef

public Object getPixelDataByRef(int plane)
                         throws IOException,
                                AutomationException
A pointer to an array of pixels for a specified plane.

Product Availability

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

Specified by:
getPixelDataByRef in interface IPixelBlock3
Parameters:
plane - The plane (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVal

public Object getVal(int plane,
                     int x,
                     int y)
              throws IOException,
                     AutomationException
The value for a specified pixel.

Description

The GetVal method returns an individual value for the pixel specified by the band and pixel location input.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVal in interface IPixelBlock3
Parameters:
plane - The plane (in)
x - The x (in)
y - The y (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoDataMask

public void setNoDataMask(int plane,
                          Object pVal)
                   throws IOException,
                          AutomationException
The NoData mask for a specified plane.

Product Availability

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

Specified by:
setNoDataMask in interface IPixelBlock3
Parameters:
plane - The plane (in)
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoDataMask

public Object getNoDataMask(int plane)
                     throws IOException,
                            AutomationException
The NoData mask for a specified plane.

Product Availability

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

Specified by:
getNoDataMask in interface IPixelBlock3
Parameters:
plane - The plane (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoDataMaskByRef

public Object getNoDataMaskByRef(int plane)
                          throws IOException,
                                 AutomationException
The NoData mask for a specified plane.

Product Availability

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

Specified by:
getNoDataMaskByRef in interface IPixelBlock3
Parameters:
plane - The plane (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoDataMaskVal

public Object getNoDataMaskVal(int plane,
                               int x,
                               int y)
                        throws IOException,
                               AutomationException
Gets the NoData mask value for a specified pixel.

Description

The GetNoDataMaskVal property allows you to identify whether a specific pixel is NoData or not. Value 1 means this corresponding pixel has a value and 0 means this corresponding pixel is NoData

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNoDataMaskVal in interface IPixelBlock3
Parameters:
plane - The plane (in)
x - The x (in)
y - The y (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasNoData

public boolean hasNoData(int plane)
                  throws IOException,
                         AutomationException
Checks if this PixelBlock contains NoData.

Description

The HasNoData property indicates whether the PixelBlock has NoData or not. True means it has NoData.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
hasNoData in interface IPixelBlock3
Parameters:
plane - The plane (in)
Returns:
The hasNoData
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear(int plane)
           throws IOException,
                  AutomationException
Clears a given plane (sets to NoData).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
clear in interface IPixelBlock3
Parameters:
plane - The plane (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mask

public void mask(Object noData)
          throws IOException,
                 AutomationException
Generates NoData Mask using a given NoData value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
mask in interface IPixelBlock3
Parameters:
noData - A Variant (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