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

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

public class TopoToRasterByFile
extends AbstractGPTool

Interpolates a hydrologically correct raster surface from point, line, and polygon data using parameters specified in a file. The Topo to Raster by File 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
TopoToRasterByFile()
          Creates the Topo to Raster by File tool with defaults.
TopoToRasterByFile(Object inParameterFile, Object outSurfaceRaster)
          Creates the Topo to Raster by File tool with the required parameters.
 
Method Summary
 Object getInParameterFile()
          Returns the Input parameter file parameter of this tool .
 Object getOutSinkFeatures()
          Returns the Output remaining sink point features parameter of this tool .
 Object getOutStreamFeatures()
          Returns the Output stream polyline features parameter of this tool .
 Object getOutSurfaceRaster()
          Returns the Output surface 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 setInParameterFile(Object inParameterFile)
          Sets the Input parameter file parameter of this tool .
 void setOutSinkFeatures(Object outSinkFeatures)
          Sets the Output remaining sink point features parameter of this tool .
 void setOutStreamFeatures(Object outStreamFeatures)
          Sets the Output stream polyline features parameter of this tool .
 void setOutSurfaceRaster(Object outSurfaceRaster)
          Sets the Output surface 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

TopoToRasterByFile

public TopoToRasterByFile()
Creates the Topo to Raster by File tool with defaults.

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


TopoToRasterByFile

public TopoToRasterByFile(Object inParameterFile,
                          Object outSurfaceRaster)
Creates the Topo to Raster by File 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:
inParameterFile - the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time.
outSurfaceRaster - the output interpolated surface raster.
Method Detail

getInParameterFile

public Object getInParameterFile()
Returns the Input parameter file parameter of this tool . This parameter is the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time. This is a required parameter.

Returns:
the Input parameter file

setInParameterFile

public void setInParameterFile(Object inParameterFile)
Sets the Input parameter file parameter of this tool . This parameter is the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time. This is a required parameter.

Parameters:
inParameterFile - the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time.

getOutSurfaceRaster

public Object getOutSurfaceRaster()
Returns the Output surface raster parameter of this tool . This parameter is the output interpolated surface raster. This is a required parameter.

Returns:
the Output surface raster

setOutSurfaceRaster

public void setOutSurfaceRaster(Object outSurfaceRaster)
Sets the Output surface raster parameter of this tool . This parameter is the output interpolated surface raster. This is a required parameter.

Parameters:
outSurfaceRaster - the output interpolated surface raster.

getOutStreamFeatures

public Object getOutStreamFeatures()
Returns the Output stream polyline features parameter of this tool . This parameter is output feature class of stream polyline features. This is an optional parameter.

Returns:
the Output stream polyline features

setOutStreamFeatures

public void setOutStreamFeatures(Object outStreamFeatures)
Sets the Output stream polyline features parameter of this tool . This parameter is output feature class of stream polyline features. This is an optional parameter.

Parameters:
outStreamFeatures - output feature class of stream polyline features.

getOutSinkFeatures

public Object getOutSinkFeatures()
Returns the Output remaining sink point features parameter of this tool . This parameter is output feature class of remaining sink point features. This is an optional parameter.

Returns:
the Output remaining sink point features

setOutSinkFeatures

public void setOutSinkFeatures(Object outSinkFeatures)
Sets the Output remaining sink point features parameter of this tool . This parameter is output feature class of remaining sink point features. This is an optional parameter.

Parameters:
outSinkFeatures - output feature class of remaining sink point features.

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