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

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

public class FloatToRaster
extends AbstractGPTool

Converts a file of binary floating-point values representing raster data to a raster dataset. The Float 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
FloatToRaster()
          Creates the Float to Raster tool with defaults.
FloatToRaster(Object inFloatFile, Object outRaster)
          Creates the Float to Raster tool with the required parameters.
 
Method Summary
 Object getInFloatFile()
          Returns the Input floating point 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 setInFloatFile(Object inFloatFile)
          Sets the Input floating point 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

FloatToRaster

public FloatToRaster()
Creates the Float to Raster tool with defaults.

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


FloatToRaster

public FloatToRaster(Object inFloatFile,
                     Object outRaster)
Creates the Float 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:
inFloatFile - File, the input floating-point binary file. The file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension.
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

getInFloatFile

public Object getInFloatFile()
Returns the Input floating point raster file parameter of this tool . This parameter is File, the input floating-point binary file. The file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension. This is a required parameter.

Returns:
the Input floating point raster file

setInFloatFile

public void setInFloatFile(Object inFloatFile)
Sets the Input floating point raster file parameter of this tool . This parameter is File, the input floating-point binary file. The file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension. This is a required parameter.

Parameters:
inFloatFile - File, the input floating-point binary file. The file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension.

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.

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