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

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

public class Transform
extends AbstractGPTool

Moves all features in a coverage based on a set of from and to control points. The Transform 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
Transform()
          Creates the Transform tool with defaults.
Transform(Object inCover, Object outCover)
          Creates the Transform tool with the required parameters.
 
Method Summary
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 Object getOutCoverage()
          Returns the Output Coverage 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.
 String getTransformType()
          Returns the Transformation Type parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setTransformType(String transformType)
          Sets the Transformation Type 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

Transform

public Transform()
Creates the Transform tool with defaults.

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


Transform

public Transform(Object inCover,
                 Object outCover)
Creates the Transform 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:
inCover - the coverage whose coordinates are to be transformed.
outCover - the name of an existing coverage containing destination tics. The features from the input coverage will be transformed into this coverage.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the coverage whose coordinates are to be transformed. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is the coverage whose coordinates are to be transformed. This is a required parameter.

Parameters:
inCover - the coverage whose coordinates are to be transformed.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the name of an existing coverage containing destination tics. The features from the input coverage will be transformed into this coverage. 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 an existing coverage containing destination tics. The features from the input coverage will be transformed into this coverage. This is a required parameter.

Parameters:
outCover - the name of an existing coverage containing destination tics. The features from the input coverage will be transformed into this coverage.

getTransformType

public String getTransformType()
Returns the Transformation Type parameter of this tool . This parameter is the type of coordinate transformation to be performed: This is an optional parameter.

Returns:
the Transformation Type

setTransformType

public void setTransformType(String transformType)
Sets the Transformation Type parameter of this tool . This parameter is the type of coordinate transformation to be performed: This is an optional parameter.

Parameters:
transformType - the type of coordinate transformation to be performed:

getOutCoverage

public Object getOutCoverage()
Returns the Output Coverage parameter of this tool (Read only). This is an derived parameter.

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