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

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

public class RasterToOtherFormat
extends AbstractGPTool

Converts one or more raster dataset formats supported by ArcGIS to a BIL, BIP, BMP, BSQ, ENVI DAT, GIF, GRID, ERDAS IMAGINE, JPEG, JPEG 2000, PNG TIFF, or to a geodatabase raster dataset format. The Raster To Other Format (multiple) 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
RasterToOtherFormat()
          Creates the Raster To Other Format (multiple) tool with defaults.
RasterToOtherFormat(Object inputRasters, Object outputWorkspace)
          Creates the Raster To Other Format (multiple) tool with the required parameters.
 
Method Summary
 Object getDerivedWorkspace()
          Returns the Derived Workspace parameter of this tool (Read only).
 Object getInputRasters()
          Returns the Input Rasters parameter of this tool .
 Object getOutputWorkspace()
          Returns the Output Workspace parameter of this tool .
 String getRasterFormat()
          Returns the Raster Format 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 setInputRasters(Object inputRasters)
          Sets the Input Rasters parameter of this tool .
 void setOutputWorkspace(Object outputWorkspace)
          Sets the Output Workspace parameter of this tool .
 void setRasterFormat(String rasterFormat)
          Sets the Raster Format 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

RasterToOtherFormat

public RasterToOtherFormat()
Creates the Raster To Other Format (multiple) tool with defaults.

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


RasterToOtherFormat

public RasterToOtherFormat(Object inputRasters,
                           Object outputWorkspace)
Creates the Raster To Other Format (multiple) 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:
inputRasters - the input raster datasets that you wish to convert.
outputWorkspace - the location where converted raster datasets will be stored.
Method Detail

getInputRasters

public Object getInputRasters()
Returns the Input Rasters parameter of this tool . This parameter is the input raster datasets that you wish to convert. This is a required parameter.

Returns:
the Input Rasters

setInputRasters

public void setInputRasters(Object inputRasters)
Sets the Input Rasters parameter of this tool . This parameter is the input raster datasets that you wish to convert. This is a required parameter.

Parameters:
inputRasters - the input raster datasets that you wish to convert.

getOutputWorkspace

public Object getOutputWorkspace()
Returns the Output Workspace parameter of this tool . This parameter is the location where converted raster datasets will be stored. This is a required parameter.

Returns:
the Output Workspace

setOutputWorkspace

public void setOutputWorkspace(Object outputWorkspace)
Sets the Output Workspace parameter of this tool . This parameter is the location where converted raster datasets will be stored. This is a required parameter.

Parameters:
outputWorkspace - the location where converted raster datasets will be stored.

getRasterFormat

public String getRasterFormat()
Returns the Raster Format parameter of this tool . This parameter is the format of the output raster dataset. This is an optional parameter.

Returns:
the Raster Format

setRasterFormat

public void setRasterFormat(String rasterFormat)
Sets the Raster Format parameter of this tool . This parameter is the format of the output raster dataset. This is an optional parameter.

Parameters:
rasterFormat - the format of the output raster dataset.

getDerivedWorkspace

public Object getDerivedWorkspace()
Returns the Derived Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Derived Workspace

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