com.esri.arcgis.datasourcesraster
Class RasterFunctionHelper

java.lang.Object
  com.esri.arcgis.datasourcesraster.RasterFunctionHelper

All Implemented Interfaces:

IRasterFunctionHelper, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterFunctionHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionHelper

A class for a raster function helper.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterFunctionHelper()
Constructs a RasterFunctionHelper using ArcGIS Engine.

RasterFunctionHelper(Object obj)
Construct a RasterFunctionHelper using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	bind(Object pArguments) Binds function arguments to the associated raster function.
void	createRaster(IRaster pRaster, IRaster pReferenceRaster, ILongArray[] ppBandIDs, IRaster[] ppNewRaster) Creates a new raster using a given reference raster.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IRaster	getRaster() The current source raster.
IRasterInfo	getRasterInfo() The raster information after this function is applied to an object.
int	getReferenceProperties() The properties to be used in reference raster.
int	hashCode() the hashcode for this object
boolean	isResampling() Indicates if this raster source wants to perform resampling.
boolean	isSupportBandSelection() Indicates if this function supports band selection.
void	read(IPnt pTlc, IRaster pRaster, IRaster pReferenceRaster, IPixelBlock pPixelBlock) Reads a pixel block starting from the top left corner.
void	setReferenceProperties(int pReferenceProperties) The properties to be used in reference raster.
void	setResampling(boolean pResampling) Indicates if this raster source wants to perform resampling.
void	setSupportBandSelection(boolean pSupportBandSelection) Indicates if this function supports band selection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterFunctionHelper

public RasterFunctionHelper()
                     throws IOException,
                            UnknownHostException

Constructs a RasterFunctionHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterFunctionHelper

public RasterFunctionHelper(Object obj)
                     throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems RasterFunctionHelper theRasterFunctionHelper = (RasterFunctionHelper) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

bind

public void bind(Object pArguments)
          throws IOException,
                 AutomationException

Binds function arguments to the associated raster function.

Product Availability

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

Specified by:

bind in interface IRasterFunctionHelper

Parameters:

pArguments - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The raster information after this function is applied to an object.

Product Availability

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

Specified by:

getRasterInfo in interface IRasterFunctionHelper

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

read

public void read(IPnt pTlc,
                 IRaster pRaster,
                 IRaster pReferenceRaster,
                 IPixelBlock pPixelBlock)
          throws IOException,
                 AutomationException

Reads a pixel block starting from the top left corner.

Product Availability

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

Specified by:

read in interface IRasterFunctionHelper

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pReferenceRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResampling

public boolean isResampling()
                     throws IOException,
                            AutomationException

Indicates if this raster source wants to perform resampling.

Product Availability

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

Specified by:

isResampling in interface IRasterFunctionHelper

Returns:

The pResampling

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResampling

public void setResampling(boolean pResampling)
                   throws IOException,
                          AutomationException

Indicates if this raster source wants to perform resampling.

Product Availability

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

Specified by:

setResampling in interface IRasterFunctionHelper

Parameters:

pResampling - The pResampling (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceProperties

public int getReferenceProperties()
                           throws IOException,
                                  AutomationException

The properties to be used in reference raster.

Product Availability

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

Specified by:

getReferenceProperties in interface IRasterFunctionHelper

Returns:

The pReferenceProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceProperties

public void setReferenceProperties(int pReferenceProperties)
                            throws IOException,
                                   AutomationException

The properties to be used in reference raster.

Product Availability

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

Specified by:

setReferenceProperties in interface IRasterFunctionHelper

Parameters:

pReferenceProperties - The pReferenceProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportBandSelection

public boolean isSupportBandSelection()
                               throws IOException,
                                      AutomationException

Indicates if this function supports band selection.

Product Availability

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

Specified by:

isSupportBandSelection in interface IRasterFunctionHelper

Returns:

The pSupportBandSelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportBandSelection

public void setSupportBandSelection(boolean pSupportBandSelection)
                             throws IOException,
                                    AutomationException

Indicates if this function supports band selection.

Product Availability

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

Specified by:

setSupportBandSelection in interface IRasterFunctionHelper

Parameters:

pSupportBandSelection - The pSupportBandSelection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRaster

public void createRaster(IRaster pRaster,
                         IRaster pReferenceRaster,
                         ILongArray[] ppBandIDs,
                         IRaster[] ppNewRaster)
                  throws IOException,
                         AutomationException

Creates a new raster using a given reference raster.

Product Availability

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

Specified by:

createRaster in interface IRasterFunctionHelper

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pReferenceRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

ppBandIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

ppNewRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws IOException,
                         AutomationException

The current source raster.

Product Availability

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

Specified by:

getRaster in interface IRasterFunctionHelper

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.