com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class SingleOutputMapAlgebra

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.SingleOutputMapAlgebra

All Implemented Interfaces:

GPTool

public class SingleOutputMapAlgebra
extends AbstractGPTool

Runs a single expression built with the Map Algebra language. The Single Output Map Algebra tool is contained in the Spatial Analyst Tools tool box.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SingleOutputMapAlgebra()
Creates the Single Output Map Algebra tool with defaults.

SingleOutputMapAlgebra(Object expressionString, Object outRaster)
Creates the Single Output Map Algebra tool with the required parameters.

Method Summary

Object	getExpressionString() Returns the Map Algebra expression parameter of this tool .
Object	getInData() Returns the Input raster or feature data parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setExpressionString(Object expressionString) Sets the Map Algebra expression parameter of this tool .
void	setInData(Object inData) Sets the Input raster or feature data parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleOutputMapAlgebra

public SingleOutputMapAlgebra()

Creates the Single Output Map Algebra tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

SingleOutputMapAlgebra

public SingleOutputMapAlgebra(Object expressionString,
                              Object outRaster)

Creates the Single Output Map Algebra tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

expressionString - MapAlgebra Expression, MapAlgebra Expression, the string containing the expression you want to run, constructed with the Map Algebra language. an example expression is:

outRaster - Raster Dataset, the output raster to be created from the Map Algebra expression.

Method Detail

getExpressionString

public Object getExpressionString()

Returns the Map Algebra expression parameter of this tool . This parameter is MapAlgebra Expression, MapAlgebra Expression, the string containing the expression you want to run, constructed with the Map Algebra language. an example expression is: This is a required parameter.

Returns:

the Map Algebra expression

setExpressionString

public void setExpressionString(Object expressionString)

Sets the Map Algebra expression parameter of this tool . This parameter is MapAlgebra Expression, MapAlgebra Expression, the string containing the expression you want to run, constructed with the Map Algebra language. an example expression is: This is a required parameter.

Parameters:

expressionString - MapAlgebra Expression, MapAlgebra Expression, the string containing the expression you want to run, constructed with the Map Algebra language. an example expression is:

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the output raster to be created from the Map Algebra expression. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the output raster to be created from the Map Algebra expression. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the output raster to be created from the Map Algebra expression.

getInData

public Object getInData()

Returns the Input raster or feature data parameter of this tool . This parameter is Composite Geodataset, Composite Geodataset, the list of input data that can be shown in Model Builder. the inputs can be raster or feature data. This is an optional parameter.

Returns:

the Input raster or feature data

setInData

public void setInData(Object inData)

Sets the Input raster or feature data parameter of this tool . This parameter is Composite Geodataset, Composite Geodataset, the list of input data that can be shown in Model Builder. the inputs can be raster or feature data. This is an optional parameter.

Parameters:

inData - Composite Geodataset, Composite Geodataset, the list of input data that can be shown in Model Builder. the inputs can be raster or feature data.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias