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

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

public class Basin
extends AbstractGPTool

Creates a raster delineating all drainage basins. The Basin tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Basin works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Basin()
          Creates the Basin tool with defaults.
Basin(Object inFlowDirectionRaster, Object outRaster)
          Creates the Basin tool with the required parameters.
 
Method Summary
 Object getInFlowDirectionRaster()
          Returns the Input flow direction raster 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 setInFlowDirectionRaster(Object inFlowDirectionRaster)
          Sets the Input flow direction raster 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

Basin

public Basin()
Creates the Basin tool with defaults.

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


Basin

public Basin(Object inFlowDirectionRaster,
             Object outRaster)
Creates the Basin 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:
inFlowDirectionRaster - Composite Geodataset, this is created with the Flow Direction function.
outRaster - Raster Dataset, the output raster that delineates the drainage basins.
Method Detail

getInFlowDirectionRaster

public Object getInFlowDirectionRaster()
Returns the Input flow direction raster parameter of this tool . This parameter is Composite Geodataset, this is created with the Flow Direction function. This is a required parameter.

Returns:
the Input flow direction raster

setInFlowDirectionRaster

public void setInFlowDirectionRaster(Object inFlowDirectionRaster)
Sets the Input flow direction raster parameter of this tool . This parameter is Composite Geodataset, this is created with the Flow Direction function. This is a required parameter.

Parameters:
inFlowDirectionRaster - Composite Geodataset, this is created with the Flow Direction function.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the output raster that delineates the drainage basins. 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 that delineates the drainage basins. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the output raster that delineates the drainage basins.

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