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

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

public class Expand
extends AbstractGPTool

Expands specified zones of a raster by a specified number of cells. The Expand tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Expand works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Expand()
          Creates the Expand tool with defaults.
Expand(Object inRaster, Object outRaster, int numberCells, Object zoneValues)
          Creates the Expand tool with the required parameters.
 
Method Summary
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 int getNumberCells()
          Returns the Number of cells 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 getZoneValues()
          Returns the Zone values parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setNumberCells(int numberCells)
          Sets the Number of cells parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setZoneValues(Object zoneValues)
          Sets the Zone values 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

Expand

public Expand()
Creates the Expand tool with defaults.

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


Expand

public Expand(Object inRaster,
              Object outRaster,
              int numberCells,
              Object zoneValues)
Creates the Expand 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:
inRaster - Composite Geodataset, it must be of integer type.
outRaster - Raster Dataset, the raster to be created.
numberCells - Long, the number of cells to expand each specified zone by.
zoneValues - Long, the list of zone values to expand.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, it must be of integer type. This is a required parameter.

Returns:
the Input raster

setInRaster

public void setInRaster(Object inRaster)
Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, it must be of integer type. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, it must be of integer type.

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.

getNumberCells

public int getNumberCells()
Returns the Number of cells parameter of this tool . This parameter is Long, the number of cells to expand each specified zone by. This is a required parameter.

Returns:
the Number of cells

setNumberCells

public void setNumberCells(int numberCells)
Sets the Number of cells parameter of this tool . This parameter is Long, the number of cells to expand each specified zone by. This is a required parameter.

Parameters:
numberCells - Long, the number of cells to expand each specified zone by.

getZoneValues

public Object getZoneValues()
Returns the Zone values parameter of this tool . This parameter is Long, the list of zone values to expand. This is a required parameter.

Returns:
the Zone values

setZoneValues

public void setZoneValues(Object zoneValues)
Sets the Zone values parameter of this tool . This parameter is Long, the list of zone values to expand. This is a required parameter.

Parameters:
zoneValues - Long, the list of zone values to expand.

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