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

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

public class DefineProjection
extends AbstractGPTool

Records the coordinate system information of the Input Coverage including any associated projection parameters, such as datum and spheroid. The Define Projection 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
DefineProjection()
          Creates the Define Projection tool with defaults.
DefineProjection(Object inCover, Object projectionFile)
          Creates the Define Projection 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 (Read only).
 Object getProjectionFile()
          Returns the Projection File 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 setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setProjectionFile(Object projectionFile)
          Sets the Projection File 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

DefineProjection

public DefineProjection()
Creates the Define Projection tool with defaults.

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


DefineProjection

public DefineProjection(Object inCover,
                        Object projectionFile)
Creates the Define Projection 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 for which the projection information is being defined.
projectionFile - the name of a text file defining the input projection parameters.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the coverage for which the projection information is being defined. 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 for which the projection information is being defined. This is a required parameter.

Parameters:
inCover - the coverage for which the projection information is being defined.

getProjectionFile

public Object getProjectionFile()
Returns the Projection File parameter of this tool . This parameter is the name of a text file defining the input projection parameters. This is a required parameter.

Returns:
the Projection File

setProjectionFile

public void setProjectionFile(Object projectionFile)
Sets the Projection File parameter of this tool . This parameter is the name of a text file defining the input projection parameters. This is a required parameter.

Parameters:
projectionFile - the name of a text file defining the input projection parameters.

getOutCover

public Object getOutCover()
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