com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class ExportRasterWorldFile

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

public class ExportRasterWorldFile
extends AbstractGPTool

Creates a world file based on the geographic information of a raster dataset. The pixel size and the location of the upper left pixel is extracted for the world file. The Export Raster World File tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ExportRasterWorldFile()
          Creates the Export Raster World File tool with defaults.
ExportRasterWorldFile(Object inRasterDataset)
          Creates the Export Raster World File tool with the required parameters.
 
Method Summary
 Object getInRasterDataset()
          Returns the Input Raster Dataset parameter of this tool .
 Object getOutRasterDataset()
          Returns the Output Raster Dataset parameter of this tool (Read only).
 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 setInRasterDataset(Object inRasterDataset)
          Sets the Input Raster Dataset 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

ExportRasterWorldFile

public ExportRasterWorldFile()
Creates the Export Raster World File tool with defaults.

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


ExportRasterWorldFile

public ExportRasterWorldFile(Object inRasterDataset)
Creates the Export Raster World 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:
inRasterDataset - Raster dataset, the raster dataset for which the world file will be created.
Method Detail

getInRasterDataset

public Object getInRasterDataset()
Returns the Input Raster Dataset parameter of this tool . This parameter is Raster dataset, the raster dataset for which the world file will be created. This is a required parameter.

Returns:
the Input Raster Dataset

setInRasterDataset

public void setInRasterDataset(Object inRasterDataset)
Sets the Input Raster Dataset parameter of this tool . This parameter is Raster dataset, the raster dataset for which the world file will be created. This is a required parameter.

Parameters:
inRasterDataset - Raster dataset, the raster dataset for which the world file will be created.

getOutRasterDataset

public Object getOutRasterDataset()
Returns the Output Raster Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
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