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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ConTool
All Implemented Interfaces:
GPTool

public class ConTool
extends AbstractGPTool

Performs a conditional if/else evaluation on each of the input cells of an input raster. The Con tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Con works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ConTool()
          Creates the Con tool with defaults.
ConTool(Object inConditionalRaster, Object inTrueRasterOrConstant, Object outRaster)
          Creates the Con tool with the required parameters.
 
Method Summary
 Object getInConditionalRaster()
          Returns the Input conditional raster parameter of this tool .
 Object getInFalseRasterOrConstant()
          Returns the Input false raster or constant value parameter of this tool .
 Object getInTrueRasterOrConstant()
          Returns the Input true raster or constant value 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.
 Object getWhereClause()
          Returns the Expression parameter of this tool .
 void setInConditionalRaster(Object inConditionalRaster)
          Sets the Input conditional raster parameter of this tool .
 void setInFalseRasterOrConstant(Object inFalseRasterOrConstant)
          Sets the Input false raster or constant value parameter of this tool .
 void setInTrueRasterOrConstant(Object inTrueRasterOrConstant)
          Sets the Input true raster or constant value parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setWhereClause(Object whereClause)
          Sets the Expression 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

ConTool

public ConTool()
Creates the Con tool with defaults.

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


ConTool

public ConTool(Object inConditionalRaster,
               Object inTrueRasterOrConstant,
               Object outRaster)
Creates the Con 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:
inConditionalRaster - Composite Geodataset, the input can be an integer or float raster.
inTrueRasterOrConstant - Composite Geodataset, the input must be an integer, float raster, or constant value.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInConditionalRaster

public Object getInConditionalRaster()
Returns the Input conditional raster parameter of this tool . This parameter is Composite Geodataset, the input can be an integer or float raster. This is a required parameter.

Returns:
the Input conditional raster

setInConditionalRaster

public void setInConditionalRaster(Object inConditionalRaster)
Sets the Input conditional raster parameter of this tool . This parameter is Composite Geodataset, the input can be an integer or float raster. This is a required parameter.

Parameters:
inConditionalRaster - Composite Geodataset, the input can be an integer or float raster.

getInTrueRasterOrConstant

public Object getInTrueRasterOrConstant()
Returns the Input true raster or constant value parameter of this tool . This parameter is Composite Geodataset, the input must be an integer, float raster, or constant value. This is a required parameter.

Returns:
the Input true raster or constant value

setInTrueRasterOrConstant

public void setInTrueRasterOrConstant(Object inTrueRasterOrConstant)
Sets the Input true raster or constant value parameter of this tool . This parameter is Composite Geodataset, the input must be an integer, float raster, or constant value. This is a required parameter.

Parameters:
inTrueRasterOrConstant - Composite Geodataset, the input must be an integer, float raster, or constant value.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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 raster to be created. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the raster to be created.

getInFalseRasterOrConstant

public Object getInFalseRasterOrConstant()
Returns the Input false raster or constant value parameter of this tool . This parameter is Composite Geodataset, the input must be an integer, float raster, or constant value. This is an optional parameter.

Returns:
the Input false raster or constant value

setInFalseRasterOrConstant

public void setInFalseRasterOrConstant(Object inFalseRasterOrConstant)
Sets the Input false raster or constant value parameter of this tool . This parameter is Composite Geodataset, the input must be an integer, float raster, or constant value. This is an optional parameter.

Parameters:
inFalseRasterOrConstant - Composite Geodataset, the input must be an integer, float raster, or constant value.

getWhereClause

public Object getWhereClause()
Returns the Expression parameter of this tool . This parameter is SQL Expression, an SQL expression used to select a subset of raster cells. For information on SQL syntax, see This is an optional parameter.

Returns:
the Expression

setWhereClause

public void setWhereClause(Object whereClause)
Sets the Expression parameter of this tool . This parameter is SQL Expression, an SQL expression used to select a subset of raster cells. For information on SQL syntax, see This is an optional parameter.

Parameters:
whereClause - SQL Expression, an SQL expression used to select a subset of raster cells. For information on SQL syntax, see

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