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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.DeleteColormap

All Implemented Interfaces:

GPTool

public class DeleteColormap
extends AbstractGPTool

Removes the color map associated with a raster dataset. The Delete Colormap tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool will not work when the color map is internally stored in the attribute table of an IMG or TIFF dataset. If the attribute table contains the fields "Red", "Green", and "Blue", that means this tool cannot be used.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

DeleteColormap()
Creates the Delete Colormap tool with defaults.

DeleteColormap(Object inRaster)
Creates the Delete Colormap tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getOutRaster() Returns the Output Raster 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	setInRaster(Object inRaster) Sets the Input 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

DeleteColormap

public DeleteColormap()

Creates the Delete Colormap tool with defaults.

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

DeleteColormap

public DeleteColormap(Object inRaster)

Creates the Delete Colormap 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 raster dataset containing the color map to remove.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the raster dataset containing the color map to remove. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the raster dataset containing the color map to remove. This is a required parameter.

Parameters:

inRaster - the raster dataset containing the color map to remove.

getOutRaster

public Object getOutRaster()

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

Returns:

the Output Raster

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