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.

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 - a raster or feature dataset that identifies those cells from which the least-cost path is determined to the least costly source. 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 - the name of a cost distance raster to be used to determine the least-cost path from the destination locations to a source. the cost distance raster is usually created with the Cost Distance, Cost Allocation or Cost Back Link tools. The 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 - the name of a cost back link raster used to determine the path to return to a source via the least-cost path. for each cell in the back link 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 - the output cost path raster. the output raster is of integer type.
Method Detail

getInDestinationData

public Object getInDestinationData()
Returns the Input raster or feature destination data parameter of this tool . This parameter is a raster or feature dataset that identifies those cells from which the least-cost path is determined to the least costly source. 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 a raster or feature dataset that identifies those cells from which the least-cost path is determined to the least costly source. 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 - a raster or feature dataset that identifies those cells from which the least-cost path is determined to the least costly source. 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 the name of a cost distance raster to be used to determine the least-cost path from the destination locations to a source. the cost distance raster is usually created with the Cost Distance, Cost Allocation or Cost Back Link tools. The 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 the name of a cost distance raster to be used to determine the least-cost path from the destination locations to a source. the cost distance raster is usually created with the Cost Distance, Cost Allocation or Cost Back Link tools. The 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 - the name of a cost distance raster to be used to determine the least-cost path from the destination locations to a source. the cost distance raster is usually created with the Cost Distance, Cost Allocation or Cost Back Link tools. The 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 the name of a cost back link raster used to determine the path to return to a source via the least-cost path. for each cell in the back link 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 the name of a cost back link raster used to determine the path to return to a source via the least-cost path. for each cell in the back link 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 - the name of a cost back link raster used to determine the path to return to a source via the least-cost path. for each cell in the back link 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 the output cost path raster. the output raster is of integer type. 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 the output cost path raster. the output raster is of integer type. This is a required parameter.

Parameters:
outRaster - the output cost path raster. the output raster is of integer type.

getPathType

public String getPathType()
Returns the Path type parameter of this tool . This parameter is a keyword defining the manner in which the values and zones on the input destination data will be interpreted in the cost path calculations. 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 a keyword defining the manner in which the values and zones on the input destination data will be interpreted in the cost path calculations. This is an optional parameter.

Parameters:
pathType - a keyword defining the manner in which the values and zones on the input destination data will be interpreted in the cost path calculations.

getDestinationField

public Object getDestinationField()
Returns the Destination field parameter of this tool . This parameter is the field used to obtain values for the destination locations. 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 the field used to obtain values for the destination locations. input feature data must contain at least one valid field. This is an optional parameter.

Parameters:
destinationField - the field used to obtain values for the destination locations. 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