com.esri.arcgis.geoprocessing.tools.coveragetools
Class Create

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

public class Create
extends AbstractGPTool

Creates a new coverage. The Create Coverage tool is contained in the Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Create()
          Creates the Create Coverage tool with defaults.
Create(Object outCover)
          Creates the Create Coverage tool with the required parameters.
 
Method Summary
 Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 Object getTemplateCover()
          Returns the Template Coverage 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 setOutCover(Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setTemplateCover(Object templateCover)
          Sets the Template Coverage 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

Create

public Create()
Creates the Create Coverage tool with defaults.

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


Create

public Create(Object outCover)
Creates the Create Coverage 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:
outCover - the name of the coverage that will be created.
Method Detail

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the name of the coverage that will be created. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is the name of the coverage that will be created. This is a required parameter.

Parameters:
outCover - the name of the coverage that will be created.

getTemplateCover

public Object getTemplateCover()
Returns the Template Coverage parameter of this tool . This parameter is an existing coverage or grid whose TIC file, boundary information (BND file), and projection information (PRJ file) will be copied to the Output Coverage. This is an optional parameter.

Returns:
the Template Coverage

setTemplateCover

public void setTemplateCover(Object templateCover)
Sets the Template Coverage parameter of this tool . This parameter is an existing coverage or grid whose TIC file, boundary information (BND file), and projection information (PRJ file) will be copied to the Output Coverage. This is an optional parameter.

Parameters:
templateCover - an existing coverage or grid whose TIC file, boundary information (BND file), and projection information (PRJ file) will be copied to the Output Coverage.

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