com.esri.arcgis.geoprocessing.tools.conversiontools
Class ASCIIToRaster

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

public class ASCIIToRaster
extends AbstractGPTool

Converts an ASCII file representing raster data to a raster dataset. The ASCII to Raster tool is contained in the Conversion Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ASCIIToRaster()
          Creates the ASCII to Raster tool with defaults.
ASCIIToRaster(Object inAsciiFile, Object outRaster)
          Creates the ASCII to Raster tool with the required parameters.
 
Method Summary
 String getDataType()
          Returns the Output data type parameter of this tool .
 Object getInAsciiFile()
          Returns the Input ASCII raster file 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 setDataType(String dataType)
          Sets the Output data type parameter of this tool .
 void setInAsciiFile(Object inAsciiFile)
          Sets the Input ASCII raster file 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

ASCIIToRaster

public ASCIIToRaster()
Creates the ASCII to Raster tool with defaults.

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


ASCIIToRaster

public ASCIIToRaster(Object inAsciiFile,
                     Object outRaster)
Creates the ASCII to Raster 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:
inAsciiFile - File, the input ASCII file to be converted.
outRaster - Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format.
Method Detail

getInAsciiFile

public Object getInAsciiFile()
Returns the Input ASCII raster file parameter of this tool . This parameter is File, the input ASCII file to be converted. This is a required parameter.

Returns:
the Input ASCII raster file

setInAsciiFile

public void setInAsciiFile(Object inAsciiFile)
Sets the Input ASCII raster file parameter of this tool . This parameter is File, the input ASCII file to be converted. This is a required parameter.

Parameters:
inAsciiFile - File, the input ASCII file to be converted.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format. 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, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format. This is a required parameter.

Parameters:
outRaster - Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format.

getDataType

public String getDataType()
Returns the Output data type parameter of this tool . This parameter is String, the data type of the output raster dataset. This is an optional parameter.

Returns:
the Output data type

setDataType

public void setDataType(String dataType)
Sets the Output data type parameter of this tool . This parameter is String, the data type of the output raster dataset. This is an optional parameter.

Parameters:
dataType - String, the data type of the output raster dataset.

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