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

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

public class Sink
extends AbstractGPTool

Creates a raster identifying all sinks or areas of internal drainage. The Sink tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Sink()
          Creates the Sink tool with defaults.
Sink(java.lang.Object inFlowDirectionRaster, java.lang.Object outRaster)
          Creates the Sink tool with the required parameters.
 
Method Summary
 java.lang.Object getInFlowDirectionRaster()
          Returns the Input flow direction raster parameter of this tool .
 java.lang.Object getOutRaster()
          Returns the Output raster parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setInFlowDirectionRaster(java.lang.Object inFlowDirectionRaster)
          Sets the Input flow direction raster parameter of this tool .
 void setOutRaster(java.lang.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

Sink

public Sink()
Creates the Sink tool with defaults.

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


Sink

public Sink(java.lang.Object inFlowDirectionRaster,
            java.lang.Object outRaster)
Creates the Sink 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 - the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool.
outRaster - the output raster that shows all the sinks (areas of internal drainage) on the input surface.
Method Detail

getInFlowDirectionRaster

public java.lang.Object getInFlowDirectionRaster()
Returns the Input flow direction raster parameter of this tool . This parameter is the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool. This is a required parameter.

Returns:
the Input flow direction raster

setInFlowDirectionRaster

public void setInFlowDirectionRaster(java.lang.Object inFlowDirectionRaster)
Sets the Input flow direction raster parameter of this tool . This parameter is the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool. This is a required parameter.

Parameters:
inFlowDirectionRaster - the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool.

getOutRaster

public java.lang.Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output raster that shows all the sinks (areas of internal drainage) on the input surface. This is a required parameter.

Returns:
the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)
Sets the Output raster parameter of this tool . This parameter is the output raster that shows all the sinks (areas of internal drainage) on the input surface. This is a required parameter.

Parameters:
outRaster - the output raster that shows all the sinks (areas of internal drainage) on the input surface.

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias