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

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

All Implemented Interfaces:

GPTool

public class AddColormap
extends AbstractGPTool

Adds a color map to a raster dataset, if it does not already exist or replaces a color map with the one specified. The Add Colormap tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The color map, from a raster dataset that already exists, will be applied to the input raster dataset.
• The following environment affects this tool: current workspace;

Field Summary

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

vals

Constructor Summary

AddColormap()
Creates the Add Colormap tool with defaults.

AddColormap(Object inRaster, Object inTemplateRaster)
Creates the Add Colormap tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getInTemplateRaster() Returns the Input Template 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 .
void	setInTemplateRaster(Object inTemplateRaster) Sets the Input Template 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

AddColormap

public AddColormap()

Creates the Add Colormap tool with defaults.

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

AddColormap

public AddColormap(Object inRaster,
                   Object inTemplateRaster)

Creates the Add 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 - Raster layer, the input raster dataset to which you want to add a color map.

inTemplateRaster - Raster layer, a raster dataset with a color map that will be applied to the input raster dataset.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is Raster layer, the input raster dataset to which you want to add a color map. 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 Raster layer, the input raster dataset to which you want to add a color map. This is a required parameter.

Parameters:

inRaster - Raster layer, the input raster dataset to which you want to add a color map.

getInTemplateRaster

public Object getInTemplateRaster()

Returns the Input Template Raster parameter of this tool . This parameter is Raster layer, a raster dataset with a color map that will be applied to the input raster dataset. This is a required parameter.

Returns:

the Input Template Raster

setInTemplateRaster

public void setInTemplateRaster(Object inTemplateRaster)

Sets the Input Template Raster parameter of this tool . This parameter is Raster layer, a raster dataset with a color map that will be applied to the input raster dataset. This is a required parameter.

Parameters:

inTemplateRaster - Raster layer, a raster dataset with a color map that will be applied to the input raster dataset.

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