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

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

public class FlowLength
extends AbstractGPTool

Calculates distance or weighted distance along a flow path. The Flow Length tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Flow Length works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
FlowLength()
          Creates the Flow Length tool with defaults.
FlowLength(Object inFlowDirectionRaster, Object outRaster)
          Creates the Flow Length tool with the required parameters.
 
Method Summary
 String getDirectionMeasurement()
          Returns the Direction of measurement parameter of this tool .
 Object getInFlowDirectionRaster()
          Returns the Input flow direction raster parameter of this tool .
 Object getInWeightRaster()
          Returns the Input weight 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 setDirectionMeasurement(String directionMeasurement)
          Sets the Direction of measurement parameter of this tool .
 void setInFlowDirectionRaster(Object inFlowDirectionRaster)
          Sets the Input flow direction raster parameter of this tool .
 void setInWeightRaster(Object inWeightRaster)
          Sets the Input weight 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

FlowLength

public FlowLength()
Creates the Flow Length tool with defaults.

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


FlowLength

public FlowLength(Object inFlowDirectionRaster,
                  Object outRaster)
Creates the Flow Length 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 can be created with the Flow Direction function.
outRaster - Raster Dataset, the output raster that shows for each cell the upstream or downstream distance along a flow path.
Method Detail

getInFlowDirectionRaster

public Object getInFlowDirectionRaster()
Returns the Input flow direction raster parameter of this tool . This parameter is Composite Geodataset, this can be 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 can be created with the Flow Direction function. This is a required parameter.

Parameters:
inFlowDirectionRaster - Composite Geodataset, this can be 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 shows for each cell the upstream or downstream distance along a flow path. 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 shows for each cell the upstream or downstream distance along a flow path. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the output raster that shows for each cell the upstream or downstream distance along a flow path.

getDirectionMeasurement

public String getDirectionMeasurement()
Returns the Direction of measurement parameter of this tool . This parameter is String, the direction of measurement along the flow path. This is an optional parameter.

Returns:
the Direction of measurement

setDirectionMeasurement

public void setDirectionMeasurement(String directionMeasurement)
Sets the Direction of measurement parameter of this tool . This parameter is String, the direction of measurement along the flow path. This is an optional parameter.

Parameters:
directionMeasurement - String, the direction of measurement along the flow path.

getInWeightRaster

public Object getInWeightRaster()
Returns the Input weight raster parameter of this tool . This parameter is Composite Geodataset, if no {in_weight_raster} is specified, a default weight of one will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it. This is an optional parameter.

Returns:
the Input weight raster

setInWeightRaster

public void setInWeightRaster(Object inWeightRaster)
Sets the Input weight raster parameter of this tool . This parameter is Composite Geodataset, if no {in_weight_raster} is specified, a default weight of one will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it. This is an optional parameter.

Parameters:
inWeightRaster - Composite Geodataset, if no {in_weight_raster} is specified, a default weight of one will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it.

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