com.esri.arcgis.datasourcesraster

Class PixelBlock

java.lang.Object

com.esri.arcgis.datasourcesraster.PixelBlock

All Implemented Interfaces:

IPixelBlock2, IPixelBlock3, IPixelBlock4, IPixelBlock, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class PixelBlock
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelBlock, IPixelBlock2, IPixelBlock3, IPixelBlock4, IPersist, IPersistStream, java.io.Externalizable

COM Class 'PixelBlock'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'Esri PixelBlock, a container of pixel data.' 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

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IPixelBlock

IID, IID169bafe0_40f6_11d2_9cfa_00a0249480f0, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelBlock2

IID, IID22dded84_d0a6_448e_95be_284503ac9cac, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelBlock3

IID, IID0ed55c8f_1ec2_4b40_a5d9_f3da548f1f40, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelBlock4

IID, IID7007286c_be43_4c88_8db6_b6ee88bad01b, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
PixelBlock() Constructs a PixelBlock using ArcGIS Engine.
PixelBlock(java.lang.Object obj) Construct a PixelBlock using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the pixel block.
void	clear(int plane) Clears a given plane (sets to NoData).
void	create(int planes, int nCols, int nRows, int pixelType) Initializes the pixel block.
void	createFromPixelBlock(IPixelBlock pBlock, java.lang.Object noData) Initializes the pixel block using another pixel block.
boolean	equals(java.lang.Object o) Compare this object with another
byte[]	exportToBytes() Exports to a byte array.
int	getBytesPerPixel() The number of bytes per pixel for the PixelBlock.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getHeight() The height of the PixelBlock in pixels.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.Object	getNoDataMask(int plane) The NoData mask for a specified plane.
java.lang.Object	getNoDataMaskByRef(int plane) The NoData mask for a specified plane.
java.lang.Object	getNoDataMaskVal(int plane, int x, int y) Gets the NoData mask value for a specified pixel.
java.lang.Object	getPixelData(int plane) An array of pixels for a specified plane.
java.lang.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.
java.lang.Object	getSafeArray(int plane) A variant SafeArray of pixels for a specified plane.
java.lang.Object	getSafeArrayByRef(int plane) A variant SafeArray of pixels for a specified plane.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.Object	getVal(int plane, int x, int y) The value for a specified pixel.
int	getWidth() The width of the PixelBlock in pixels.
boolean	hasData() Checks if a PixelBlock contains any data pixels.
int	hashCode() the hashcode for this object
boolean	hasNoData() Checks if a PixelBlock contains NoData.
boolean	hasNoData(int plane) Checks if this PixelBlock contains NoData.
void	isDirty() isDirty
void	load(IStream pstm) load
void	mask(java.lang.Object noData) Generates NoData Mask using a given NoData value.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setNoDataMask(int plane, java.lang.Object pVal) The NoData mask for a specified plane.
void	setPixelData(int plane, java.lang.Object pVal) An array of pixels for a specified plane.
void	setPixelType(int plane, int val) The pixel type of the PixelBlock.
void	setSafeArray(int plane, java.lang.Object val) A variant SafeArray of pixels for a specified plane.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PixelBlock

public PixelBlock()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a PixelBlock using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

PixelBlock

public PixelBlock(java.lang.Object obj)
           throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems PixelBlock thePixelBlock = (PixelBlock) obj;

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getPlanes

public int getPlanes()
              throws java.io.IOException,
                     AutomationException

The number of pixel arrays contained in the PixelBlock.

Specified by:

getPlanes in interface IPixelBlock2

Specified by:

getPlanes in interface IPixelBlock3

Specified by:

getPlanes in interface IPixelBlock

Returns:

The val

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException

The width of the PixelBlock in pixels.

Specified by:

getWidth in interface IPixelBlock2

Specified by:

getWidth in interface IPixelBlock3

Specified by:

getWidth in interface IPixelBlock

Returns:

The val

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws java.io.IOException,
                     AutomationException

The height of the PixelBlock in pixels.

Specified by:

getHeight in interface IPixelBlock2

Specified by:

getHeight in interface IPixelBlock3

Specified by:

getHeight in interface IPixelBlock

Returns:

The val

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType(int plane)
                 throws java.io.IOException,
                        AutomationException

The pixel type of the PixelBlock.

Specified by:

getPixelType in interface IPixelBlock2

Specified by:

getPixelType in interface IPixelBlock3

Specified by:

getPixelType in interface IPixelBlock

Parameters:

plane - The plane (in)

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int plane,
                         int val)
                  throws java.io.IOException,
                         AutomationException

The pixel type of the PixelBlock.

Specified by:

setPixelType in interface IPixelBlock2

Specified by:

setPixelType in interface IPixelBlock3

Specified by:

setPixelType in interface IPixelBlock

Parameters:

plane - The plane (in)

val - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBytesPerPixel

public int getBytesPerPixel()
                     throws java.io.IOException,
                            AutomationException

The number of bytes per pixel for the PixelBlock.

Specified by:

getBytesPerPixel in interface IPixelBlock2

Specified by:

getBytesPerPixel in interface IPixelBlock3

Specified by:

getBytesPerPixel in interface IPixelBlock

Returns:

The val

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSafeArray

public java.lang.Object getSafeArray(int plane)
                              throws java.io.IOException,
                                     AutomationException

A variant SafeArray of pixels for a specified plane.

Specified by:

getSafeArray in interface IPixelBlock

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSafeArray

public void setSafeArray(int plane,
                         java.lang.Object val)
                  throws java.io.IOException,
                         AutomationException

A variant SafeArray of pixels for a specified plane.

Specified by:

setSafeArray in interface IPixelBlock

Parameters:

plane - The plane (in)

val - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVal

public java.lang.Object getVal(int plane,
                               int x,
                               int y)
                        throws java.io.IOException,
                               AutomationException

The value for a specified pixel.

Specified by:

getVal in interface IPixelBlock2

Specified by:

getVal in interface IPixelBlock3

Specified by:

getVal in interface IPixelBlock

Parameters:

plane - The plane (in)

x - The x (in)

y - The y (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSafeArrayByRef

public java.lang.Object getSafeArrayByRef(int plane)
                                   throws java.io.IOException,
                                          AutomationException

A variant SafeArray of pixels for a specified plane.

Specified by:

getSafeArrayByRef in interface IPixelBlock2

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelData

public java.lang.Object getPixelData(int plane)
                              throws java.io.IOException,
                                     AutomationException

An array of pixels for a specified plane.

Specified by:

getPixelData in interface IPixelBlock3

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelData

public void setPixelData(int plane,
                         java.lang.Object pVal)
                  throws java.io.IOException,
                         AutomationException

An array of pixels for a specified plane.

Specified by:

setPixelData in interface IPixelBlock3

Parameters:

plane - The plane (in)

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelDataByRef

public java.lang.Object getPixelDataByRef(int plane)
                                   throws java.io.IOException,
                                          AutomationException

A pointer to an array of pixels for a specified plane.

Specified by:

getPixelDataByRef in interface IPixelBlock3

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoDataMask

public void setNoDataMask(int plane,
                          java.lang.Object pVal)
                   throws java.io.IOException,
                          AutomationException

The NoData mask for a specified plane.

Specified by:

setNoDataMask in interface IPixelBlock3

Parameters:

plane - The plane (in)

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataMask

public java.lang.Object getNoDataMask(int plane)
                               throws java.io.IOException,
                                      AutomationException

The NoData mask for a specified plane.

Specified by:

getNoDataMask in interface IPixelBlock3

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataMaskByRef

public java.lang.Object getNoDataMaskByRef(int plane)
                                    throws java.io.IOException,
                                           AutomationException

The NoData mask for a specified plane.

Specified by:

getNoDataMaskByRef in interface IPixelBlock3

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataMaskVal

public java.lang.Object getNoDataMaskVal(int plane,
                                         int x,
                                         int y)
                                  throws java.io.IOException,
                                         AutomationException

Gets the NoData mask value for a specified pixel.

Specified by:

getNoDataMaskVal in interface IPixelBlock3

Parameters:

plane - The plane (in)

x - The x (in)

y - The y (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasNoData

public boolean hasNoData(int plane)
                  throws java.io.IOException,
                         AutomationException

Checks if this PixelBlock contains NoData.

Specified by:

hasNoData in interface IPixelBlock3

Parameters:

plane - The plane (in)

Returns:

The hasNoData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear(int plane)
           throws java.io.IOException,
                  AutomationException

Clears a given plane (sets to NoData).

Specified by:

clear in interface IPixelBlock3

Parameters:

plane - The plane (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mask

public void mask(java.lang.Object noData)
          throws java.io.IOException,
                 AutomationException

Generates NoData Mask using a given NoData value.

Specified by:

mask in interface IPixelBlock3

Parameters:

noData - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public void create(int planes,
                   int nCols,
                   int nRows,
                   int pixelType)
            throws java.io.IOException,
                   AutomationException

Initializes the pixel block.

Specified by:

create in interface IPixelBlock4

Parameters:

planes - The planes (in)

nCols - The nCols (in)

nRows - The nRows (in)

pixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromPixelBlock

public void createFromPixelBlock(IPixelBlock pBlock,
                                 java.lang.Object noData)
                          throws java.io.IOException,
                                 AutomationException

Initializes the pixel block using another pixel block.

Specified by:

createFromPixelBlock in interface IPixelBlock4

Parameters:

pBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

noData - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException

Clears the pixel block.

Specified by:

clear in interface IPixelBlock4

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToBytes

public byte[] exportToBytes()
                     throws java.io.IOException,
                            AutomationException

Exports to a byte array.

Specified by:

exportToBytes in interface IPixelBlock4

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasNoData

public boolean hasNoData()
                  throws java.io.IOException,
                         AutomationException

Checks if a PixelBlock contains NoData.

Specified by:

hasNoData in interface IPixelBlock4

Returns:

The pvbHasNoData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasData

public boolean hasData()
                throws java.io.IOException,
                       AutomationException

Checks if a PixelBlock contains any data pixels.

Specified by:

hasData in interface IPixelBlock4

Returns:

The pvbHasData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException