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

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

All Implemented Interfaces:

GPTool

public class InList
extends AbstractGPTool

Determines which values from the first input are contained in the other inputs, on a cell-by-cell basis within the Analysis window. The InList tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• If the first input is a raster and the value of a cell location is not contained in the set specified by the second input, the location will receive NoData on the output raster.
• If all the inputs are integers, the output raster will be integer; otherwise, it will be floating point.
• A number can be used as an input; however, the cell size and extent must first be set in the environment.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

InList()
Creates the InList tool with defaults.

InList(Object inRasterOrConstant, Object inRasterOrConstants, Object outRaster)
Creates the InList tool with the required parameters.

Method Summary

Object	getInRasterOrConstant() Returns the Input raster or constant value parameter of this tool .
Object	getInRasterOrConstants() Returns the Input raster or constant values 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	setInRasterOrConstant(Object inRasterOrConstant) Sets the Input raster or constant value parameter of this tool .
void	setInRasterOrConstants(Object inRasterOrConstants) Sets the Input raster or constant values 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

InList

public InList()

Creates the InList tool with defaults.

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

InList

public InList(Object inRasterOrConstant,
              Object inRasterOrConstants,
              Object outRaster)

Creates the InList 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:

inRasterOrConstant - Composite Geodataset, if the input value is found in any of the list inputs, it will be assigned to the output raster on a cell-by-cell basis within the Analysis window. If the input value is not found, NoData will be assigned to the output cell.

inRasterOrConstants - Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and cell size set in the analysis environment, with each location containing the input number.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is Composite Geodataset, if the input value is found in any of the list inputs, it will be assigned to the output raster on a cell-by-cell basis within the Analysis window. If the input value is not found, NoData will be assigned to the output cell. This is a required parameter.

Returns:

the Input raster or constant value

setInRasterOrConstant

public void setInRasterOrConstant(Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is Composite Geodataset, if the input value is found in any of the list inputs, it will be assigned to the output raster on a cell-by-cell basis within the Analysis window. If the input value is not found, NoData will be assigned to the output cell. This is a required parameter.

Parameters:

inRasterOrConstant - Composite Geodataset, if the input value is found in any of the list inputs, it will be assigned to the output raster on a cell-by-cell basis within the Analysis window. If the input value is not found, NoData will be assigned to the output cell.

getInRasterOrConstants

public Object getInRasterOrConstants()

Returns the Input raster or constant values parameter of this tool . This parameter is Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and cell size set in the analysis environment, with each location containing the input number. This is a required parameter.

Returns:

the Input raster or constant values

setInRasterOrConstants

public void setInRasterOrConstants(Object inRasterOrConstants)

Sets the Input raster or constant values parameter of this tool . This parameter is Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and cell size set in the analysis environment, with each location containing the input number. This is a required parameter.

Parameters:

inRasterOrConstants - Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and cell size set in the analysis environment, with each location containing the input number.

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.

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