com.esri.arcgis.datasourcesraster
Interface IRasterFunctionHelper

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IRasterFunctionHelper2

All Known Implementing Classes:

IRasterFunctionHelper2Proxy, IRasterFunctionHelperProxy, RasterFunctionHelper

public interface IRasterFunctionHelper
extends java.io.Serializable

COM Interface 'IRasterFunctionHelper'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd6deb4c8_8d59_4cca_8174_8c7c95a5707a
static int	xxDummy Deprecated. Internal use only

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.
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.
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.

Field Detail

IIDd6deb4c8_8d59_4cca_8174_8c7c95a5707a

static final int IIDd6deb4c8_8d59_4cca_8174_8c7c95a5707a

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

bind

void bind(java.lang.Object pArguments)
          throws java.io.IOException,
                 AutomationException

Binds function arguments to the associated raster function.

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

IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException

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

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

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.

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

boolean isResampling()
                     throws java.io.IOException,
                            AutomationException

Indicates if this raster source wants to perform resampling.

Returns:

The pResampling

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResampling

void setResampling(boolean pResampling)
                   throws java.io.IOException,
                          AutomationException

Indicates if this raster source wants to perform resampling.

Parameters:

pResampling - The pResampling (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceProperties

int getReferenceProperties()
                           throws java.io.IOException,
                                  AutomationException

The properties to be used in reference raster.

Returns:

The pReferenceProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceProperties

void setReferenceProperties(int pReferenceProperties)
                            throws java.io.IOException,
                                   AutomationException

The properties to be used in reference raster.

Parameters:

pReferenceProperties - The pReferenceProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportBandSelection

boolean isSupportBandSelection()
                               throws java.io.IOException,
                                      AutomationException

Indicates if this function supports band selection.

Returns:

The pSupportBandSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportBandSelection

void setSupportBandSelection(boolean pSupportBandSelection)
                             throws java.io.IOException,
                                    AutomationException

Indicates if this function supports band selection.

Parameters:

pSupportBandSelection - The pSupportBandSelection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRaster

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

Creates a new raster using a given reference raster.

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

IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException

The current source raster.

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.