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

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

public class CostPath
extends AbstractGPTool

Calculates the least-cost path from a source to a destination. The Cost Path tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CostPath()
          Creates the Cost Path tool with defaults.
CostPath(Object inDestinationData, Object inCostDistanceRaster, Object inCostBacklinkRaster, Object outRaster)
          Creates the Cost Path tool with the required parameters.
 
Method Summary
 Object getDestinationField()
          Returns the Destination field parameter of this tool .
 Object getInCostBacklinkRaster()
          Returns the Input cost backlink raster parameter of this tool .
 Object getInCostDistanceRaster()
          Returns the Input cost distance raster parameter of this tool .
 Object getInDestinationData()
          Returns the Input raster or feature destination data parameter of this tool .
 Object getOutRaster()
          Returns the Output raster parameter of this tool .
 String getPathType()
          Returns the Path type 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 setDestinationField(Object destinationField)
          Sets the Destination field parameter of this tool .
 void setInCostBacklinkRaster(Object inCostBacklinkRaster)
          Sets the Input cost backlink raster parameter of this tool .
 void setInCostDistanceRaster(Object inCostDistanceRaster)
          Sets the Input cost distance raster parameter of this tool .
 void setInDestinationData(Object inDestinationData)
          Sets the Input raster or feature destination data parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setPathType(String pathType)
          Sets the Path type 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

CostPath

public CostPath()
Creates the Cost Path tool with defaults.

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


CostPath

public CostPath(Object inDestinationData,
                Object inCostDistanceRaster,
                Object inCostBacklinkRaster,
                Object outRaster)
Creates the Cost Path 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:
inDestinationData - Composite Geodataset, if the input is a raster, the input consists of cells that have valid values (zero is a valid value), and the remaining cells must be assigned NoData.
inCostDistanceRaster - Composite Geodataset, the in_cost_distance_raster is usually created with the CostDistance function (or by the CostAllocation or CostBackLink functions). The in_cost_distance_raster stores, for each cell, the minimum accumulative cost distance over a cost surface from each cell to a set of source cells.
inCostBacklinkRaster - Composite Geodataset, for each cell in the backlink raster, a value identifies the neighbor that is the next cell on the least accumulative cost path from the cell to a single source cell or set of source cells.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInDestinationData

public Object getInDestinationData()
Returns the Input raster or feature destination data parameter of this tool . This parameter is Composite Geodataset, if the input is a raster, the input consists of cells that have valid values (zero is a valid value), and the remaining cells must be assigned NoData. This is a required parameter.

Returns:
the Input raster or feature destination data

setInDestinationData

public void setInDestinationData(Object inDestinationData)
Sets the Input raster or feature destination data parameter of this tool . This parameter is Composite Geodataset, if the input is a raster, the input consists of cells that have valid values (zero is a valid value), and the remaining cells must be assigned NoData. This is a required parameter.

Parameters:
inDestinationData - Composite Geodataset, if the input is a raster, the input consists of cells that have valid values (zero is a valid value), and the remaining cells must be assigned NoData.

getInCostDistanceRaster

public Object getInCostDistanceRaster()
Returns the Input cost distance raster parameter of this tool . This parameter is Composite Geodataset, the in_cost_distance_raster is usually created with the CostDistance function (or by the CostAllocation or CostBackLink functions). The in_cost_distance_raster stores, for each cell, the minimum accumulative cost distance over a cost surface from each cell to a set of source cells. This is a required parameter.

Returns:
the Input cost distance raster

setInCostDistanceRaster

public void setInCostDistanceRaster(Object inCostDistanceRaster)
Sets the Input cost distance raster parameter of this tool . This parameter is Composite Geodataset, the in_cost_distance_raster is usually created with the CostDistance function (or by the CostAllocation or CostBackLink functions). The in_cost_distance_raster stores, for each cell, the minimum accumulative cost distance over a cost surface from each cell to a set of source cells. This is a required parameter.

Parameters:
inCostDistanceRaster - Composite Geodataset, the in_cost_distance_raster is usually created with the CostDistance function (or by the CostAllocation or CostBackLink functions). The in_cost_distance_raster stores, for each cell, the minimum accumulative cost distance over a cost surface from each cell to a set of source cells.

getInCostBacklinkRaster

public Object getInCostBacklinkRaster()
Returns the Input cost backlink raster parameter of this tool . This parameter is Composite Geodataset, for each cell in the backlink raster, a value identifies the neighbor that is the next cell on the least accumulative cost path from the cell to a single source cell or set of source cells. This is a required parameter.

Returns:
the Input cost backlink raster

setInCostBacklinkRaster

public void setInCostBacklinkRaster(Object inCostBacklinkRaster)
Sets the Input cost backlink raster parameter of this tool . This parameter is Composite Geodataset, for each cell in the backlink raster, a value identifies the neighbor that is the next cell on the least accumulative cost path from the cell to a single source cell or set of source cells. This is a required parameter.

Parameters:
inCostBacklinkRaster - Composite Geodataset, for each cell in the backlink raster, a value identifies the neighbor that is the next cell on the least accumulative cost path from the cell to a single source cell or set of source cells.

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.

getPathType

public String getPathType()
Returns the Path type parameter of this tool . This parameter is String, with the EACH_ZONE keyword, the least-cost path for each zone begins at the cell with the lowest cost distance weighting in the zone. This is an optional parameter.

Returns:
the Path type

setPathType

public void setPathType(String pathType)
Sets the Path type parameter of this tool . This parameter is String, with the EACH_ZONE keyword, the least-cost path for each zone begins at the cell with the lowest cost distance weighting in the zone. This is an optional parameter.

Parameters:
pathType - String, with the EACH_ZONE keyword, the least-cost path for each zone begins at the cell with the lowest cost distance weighting in the zone.

getDestinationField

public Object getDestinationField()
Returns the Destination field parameter of this tool . This parameter is Field, input feature data must contain at least one valid field. This is an optional parameter.

Returns:
the Destination field

setDestinationField

public void setDestinationField(Object destinationField)
Sets the Destination field parameter of this tool . This parameter is Field, input feature data must contain at least one valid field. This is an optional parameter.

Parameters:
destinationField - Field, input feature data must contain at least one valid field.

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