com.esri.arcgis.datasourcesraster
Class RasterFunctionHelper

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

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

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

Description 'A class for a raster function helper.' 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.IRasterFunctionHelper
IID, IIDd6deb4c8_8d59_4cca_8174_8c7c95a5707a, xxDummy
 
Constructor Summary
RasterFunctionHelper()
          Constructs a RasterFunctionHelper using ArcGIS Engine.
RasterFunctionHelper(java.lang.Object obj)
          Construct a RasterFunctionHelper using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void bind(java.lang.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(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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 release()
          Release a RasterFunctionHelper.
 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
 

Constructor Detail

RasterFunctionHelper

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

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

RasterFunctionHelper

public RasterFunctionHelper(java.lang.Object obj)
                     throws java.io.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:
java.io.IOException - if there are interop problems RasterFunctionHelper theRasterFunctionHelper = (RasterFunctionHelper) 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()
Deprecated. Internal use only.

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

release

public void release()
Release a RasterFunctionHelper.

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

bind

public void bind(java.lang.Object pArguments)
          throws java.io.IOException,
                 AutomationException
Binds function arguments to the associated raster function.

Specified by:
bind in interface IRasterFunctionHelper
Parameters:
pArguments - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException
The raster information after this function is applied to an object.

Specified by:
getRasterInfo in interface IRasterFunctionHelper
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo
Throws:
java.io.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 java.io.IOException,
                 AutomationException
Reads a pixel block starting from the top left corner.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isResampling

public boolean isResampling()
                     throws java.io.IOException,
                            AutomationException
Indicates if this raster source wants to perform resampling.

Specified by:
isResampling in interface IRasterFunctionHelper
Returns:
The pResampling
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResampling

public void setResampling(boolean pResampling)
                   throws java.io.IOException,
                          AutomationException
Indicates if this raster source wants to perform resampling.

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

getReferenceProperties

public int getReferenceProperties()
                           throws java.io.IOException,
                                  AutomationException
The properties to be used in reference raster.

Specified by:
getReferenceProperties in interface IRasterFunctionHelper
Returns:
The pReferenceProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceProperties

public void setReferenceProperties(int pReferenceProperties)
                            throws java.io.IOException,
                                   AutomationException
The properties to be used in reference raster.

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

isSupportBandSelection

public boolean isSupportBandSelection()
                               throws java.io.IOException,
                                      AutomationException
Indicates if this function supports band selection.

Specified by:
isSupportBandSelection in interface IRasterFunctionHelper
Returns:
The pSupportBandSelection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportBandSelection

public void setSupportBandSelection(boolean pSupportBandSelection)
                             throws java.io.IOException,
                                    AutomationException
Indicates if this function supports band selection.

Specified by:
setSupportBandSelection in interface IRasterFunctionHelper
Parameters:
pSupportBandSelection - The pSupportBandSelection (in)
Throws:
java.io.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 java.io.IOException,
                         AutomationException
Creates a new raster using a given reference raster.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException
The current source raster.

Specified by:
getRaster in interface IRasterFunctionHelper
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.