com.esri.arcgis.spatialanalyst
Interface IGeoAnalysisFunctionArguments

All Superinterfaces:

Serializable

All Known Subinterfaces:

IConditionalFunctionArguments, ILocalFunctionArguments, IMathFunctionArguments

All Known Implementing Classes:

ConditionalFunctionArguments, LocalFunctionArguments, MathFunctionArguments

public interface IGeoAnalysisFunctionArguments
extends Serializable

Provides access to members that specify arguments to local raster functions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Method Summary

int	getCellsizeType() The different ways for estimating cellsize.
int	getExtentType() The different ways for estimating extent.
int	getOperation() The local function operation.
IRasterInfo	getRasterInfo() The raster info object describing the output of this function.
void	setCellsizeType(int pType) The different ways for estimating cellsize.
void	setExtentType(int pType) The different ways for estimating extent.
void	setOperation(int pOperation) The local function operation.
void	setRasterInfoByRef(IRasterInfo pInfo) The raster info object describing the output of this function.

Method Detail

setRasterInfoByRef

void setRasterInfoByRef(IRasterInfo pInfo)
                        throws IOException,
                               AutomationException

The raster info object describing the output of this function.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

pInfo - A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The raster info object describing the output of this function.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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.

setOperation

void setOperation(int pOperation)
                  throws IOException,
                         AutomationException

The local function operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

pOperation - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisFunctionEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperation

int getOperation()
                 throws IOException,
                        AutomationException

The local function operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Returns:

A com.esri.arcgis.spatialanalyst.esriGeoAnalysisFunctionEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtentType

int getExtentType()
                  throws IOException,
                         AutomationException

The different ways for estimating extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Returns:

A com.esri.arcgis.datasourcesraster.esriExtentType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentType

void setExtentType(int pType)
                   throws IOException,
                          AutomationException

The different ways for estimating extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriExtentType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellsizeType

int getCellsizeType()
                    throws IOException,
                           AutomationException

The different ways for estimating cellsize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Returns:

A com.esri.arcgis.datasourcesraster.esriCellsizeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellsizeType

void setCellsizeType(int pType)
                     throws IOException,
                            AutomationException

The different ways for estimating cellsize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriCellsizeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.