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

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

public class RasterToFloat
extends AbstractGPTool

Converts a raster dataset to a file of binary floating-point values representing raster data. The Raster to Float tool is contained in the Conversion Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
RasterToFloat()
          Creates the Raster to Float tool with defaults.
RasterToFloat(java.lang.Object inRaster, java.lang.Object outFloatFile)
          Creates the Raster to Float tool with the required parameters.
 
Method Summary
 java.lang.Object getInRaster()
          Returns the Input raster parameter of this tool .
 java.lang.Object getOutFloatFile()
          Returns the Output floating point raster file parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setInRaster(java.lang.Object inRaster)
          Sets the Input raster parameter of this tool .
 void setOutFloatFile(java.lang.Object outFloatFile)
          Sets the Output floating point raster file 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

RasterToFloat

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

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


RasterToFloat

public RasterToFloat(java.lang.Object inRaster,
                     java.lang.Object outFloatFile)
Creates the Raster to Float 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:
inRaster - the input raster dataset. the raster can be integer or floating-point type.
outFloatFile - the output floating-point raster file. the file name must have a .flt extension.
Method Detail

getInRaster

public java.lang.Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is the input raster dataset. the raster can be integer or floating-point type. This is a required parameter.

Returns:
the Input raster

setInRaster

public void setInRaster(java.lang.Object inRaster)
Sets the Input raster parameter of this tool . This parameter is the input raster dataset. the raster can be integer or floating-point type. This is a required parameter.

Parameters:
inRaster - the input raster dataset. the raster can be integer or floating-point type.

getOutFloatFile

public java.lang.Object getOutFloatFile()
Returns the Output floating point raster file parameter of this tool . This parameter is the output floating-point raster file. the file name must have a .flt extension. This is a required parameter.

Returns:
the Output floating point raster file

setOutFloatFile

public void setOutFloatFile(java.lang.Object outFloatFile)
Sets the Output floating point raster file parameter of this tool . This parameter is the output floating-point raster file. the file name must have a .flt extension. This is a required parameter.

Parameters:
outFloatFile - the output floating-point raster file. the file name must have a .flt extension.

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias