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

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

All Implemented Interfaces:

GPTool

public class Corridor
extends AbstractGPTool

Calculates the sum of accumulative costs for two input accumulative cost rasters. The Corridor tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• While any two floating-point rasters can be used for the input, to obtain a meaningful result they should be unaltered accumulative cost output rasters.
• The order of input is irrelevant.

Field Summary

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

vals

Constructor Summary

Corridor()
Creates the Corridor tool with defaults.

Corridor(java.lang.Object inDistanceRaster1, java.lang.Object inDistanceRaster2, java.lang.Object outRaster)
Creates the Corridor tool with the required parameters.

Method Summary

java.lang.Object	getInDistanceRaster1() Returns the Input cost distance raster 1 parameter of this tool .
java.lang.Object	getInDistanceRaster2() Returns the Input cost distance raster 2 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	setInDistanceRaster1(java.lang.Object inDistanceRaster1) Sets the Input cost distance raster 1 parameter of this tool .
void	setInDistanceRaster2(java.lang.Object inDistanceRaster2) Sets the Input cost distance raster 2 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

Corridor

public Corridor()

Creates the Corridor tool with defaults.

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

Corridor

public Corridor(java.lang.Object inDistanceRaster1,
                java.lang.Object inDistanceRaster2,
                java.lang.Object outRaster)

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

inDistanceRaster1 - an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance.

inDistanceRaster2 - an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance.

outRaster - the output corridor raster.

Method Detail

getInDistanceRaster1

public java.lang.Object getInDistanceRaster1()

Returns the Input cost distance raster 1 parameter of this tool . This parameter is an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance. This is a required parameter.

Returns:

the Input cost distance raster 1

setInDistanceRaster1

public void setInDistanceRaster1(java.lang.Object inDistanceRaster1)

Sets the Input cost distance raster 1 parameter of this tool . This parameter is an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance. This is a required parameter.

Parameters:

inDistanceRaster1 - an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance.

getInDistanceRaster2

public java.lang.Object getInDistanceRaster2()

Returns the Input cost distance raster 2 parameter of this tool . This parameter is an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance. This is a required parameter.

Returns:

the Input cost distance raster 2

setInDistanceRaster2

public void setInDistanceRaster2(java.lang.Object inDistanceRaster2)

Sets the Input cost distance raster 2 parameter of this tool . This parameter is an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance. This is a required parameter.

Parameters:

inDistanceRaster2 - an input floating point raster. it should be an accumulated cost distance output from a distance tool such as Cost Distance or Path Distance.

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output corridor raster. 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 corridor raster. This is a required parameter.

Parameters:

outRaster - the output corridor raster.

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