com.esri.arcgis.geoanalyst
Interface IRasterModel

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterModel

public interface IRasterModel
extends Serializable

Provides access to members that control the Raster Model.

Remarks

The RasterModel object is used to perform raster analysis using map algebra expressions and may include non-raster input/output formats (feature data, tables, etc). It also allows multiple lines of Map Algebra syntax to be used.

Steps to run a process using iRastermodel interface are as follows

1. Declare rastermodel object
2. Define the inputs into the expression using the "Bind..." methods
3. Create a map algebra expression string using the Script property
4. Execute the expression
5. Specify the output from the expression to an object using the "Bound..." property
6. Release the reference to the input/output data using the UnbindSymbol method
   

Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Method Summary

void	bindFeatureClass(IFeatureClass featureClass, String symbol) Binds a symbol to a FeatureClass.
void	bindRaster(IRaster raster, String symbol) Binds a symbol to a Raster.
void	bindString(String strName, String symbol) Binds a symbol to a String.
void	bindTable(ITable table, String symbol) Binds a symbol to a Table.
void	execute() Produces a Raster by executing a script.
IFeatureClass	getBoundFeatureClass(String symbol) Finds the FeatureClass corresponding to a symbol.
IRaster	getBoundRaster(String symbol) Finds the Raster corresponding to a symbol.
ITable	getBoundTable(String symbol) Finds the Table corresponding to a symbol.
Object	getBoundUnknown(String symbol) Finds the interface pointer corresponding to a symbol.
void	setScript(String rhs1) The model script.
void	unbindSymbol(String symbol) Unbinds a symbol.

Method Detail

setScript

void setScript(String rhs1)
               throws IOException,
                      AutomationException

The model script.

Remarks

A string specifying the expression to be executed. The script string needs to contain the references to the input data [for the process(es) to be run] that were defined using the "Bind..." methods. The syntax of the expression needs to be a valid Map Algebra expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindRaster

void bindRaster(IRaster raster,
                String symbol)
                throws IOException,
                       AutomationException

Binds a symbol to a Raster.

Remarks

Raster	an input raster object created using IRaster interface
symbol	a string name which identifies the input Raster

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

symbol - The symbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindFeatureClass

void bindFeatureClass(IFeatureClass featureClass,
                      String symbol)
                      throws IOException,
                             AutomationException

Binds a symbol to a FeatureClass.

Remarks

FeatureClass	an input FeatureClass object created using IFeatureClass interface
symbol	a string name which identifies the input FeatureClass

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

symbol - The symbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindTable

void bindTable(ITable table,
               String symbol)
               throws IOException,
                      AutomationException

Binds a symbol to a Table.

Remarks

table	an input table object that implements ITable interface
symbol	a string name which identifies the input table

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

symbol - The symbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindString

void bindString(String strName,
                String symbol)
                throws IOException,
                       AutomationException

Binds a symbol to a String.

Remarks

strName	a string value representing a name of an input object. It is typically used to specify files but can also represent the names of datasets such as Raster, FeatureClass...etc
symbol	a string name used to represent the input strName

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

strName - The strName (in)

symbol - The symbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

void execute()
             throws IOException,
                    AutomationException

Produces a Raster by executing a script.

Remarks

This method creates an object by executing the string expression created using the IRasterModel:Script property. The script defines the map algebra expression to run a process, or processes, using input data that are defined by the "Bind" methods.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundRaster

IRaster getBoundRaster(String symbol)
                       throws IOException,
                              AutomationException

Finds the Raster corresponding to a symbol.

Product Availability

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

Parameters:

symbol - The symbol (in)

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.

getBoundFeatureClass

IFeatureClass getBoundFeatureClass(String symbol)
                                   throws IOException,
                                          AutomationException

Finds the FeatureClass corresponding to a symbol.

Product Availability

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

Parameters:

symbol - The symbol (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundTable

ITable getBoundTable(String symbol)
                     throws IOException,
                            AutomationException

Finds the Table corresponding to a symbol.

Product Availability

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

Parameters:

symbol - The symbol (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundUnknown

Object getBoundUnknown(String symbol)
                       throws IOException,
                              AutomationException

Finds the interface pointer corresponding to a symbol.

Product Availability

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

Parameters:

symbol - The symbol (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unbindSymbol

void unbindSymbol(String symbol)
                  throws IOException,
                         AutomationException

Unbinds a symbol.

Remarks

symbol

a string specifying the name of a bound symbol object that supports the IRasterModel interface

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - The symbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.