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

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

public class CreateCustomGeoTransformation
extends AbstractGPTool

Creates a transformation method for converting data between two geographic coordinate systems or datums. The output of this tool can be used as a transformation method for any tool with a parameter that requires such a method. The Create Custom Geographic Transformation tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateCustomGeoTransformation()
          Creates the Create Custom Geographic Transformation tool with defaults.
CreateCustomGeoTransformation(String geotName, Object inCoorSystem, Object outCoorSystem, String customGeot)
          Creates the Create Custom Geographic Transformation tool with the required parameters.
 
Method Summary
 String getCustomGeot()
          Returns the Custom Geographic Transformation parameter of this tool .
 String getGeotName()
          Returns the Geographic Transformation Name parameter of this tool .
 Object getInCoorSystem()
          Returns the Input Geographic Coordinate System parameter of this tool .
 Object getOutCoorSystem()
          Returns the Output Geographic Coordinate System 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 setCustomGeot(String customGeot)
          Sets the Custom Geographic Transformation parameter of this tool .
 void setGeotName(String geotName)
          Sets the Geographic Transformation Name parameter of this tool .
 void setInCoorSystem(Object inCoorSystem)
          Sets the Input Geographic Coordinate System parameter of this tool .
 void setOutCoorSystem(Object outCoorSystem)
          Sets the Output Geographic Coordinate System 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

CreateCustomGeoTransformation

public CreateCustomGeoTransformation()
Creates the Create Custom Geographic Transformation tool with defaults.

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


CreateCustomGeoTransformation

public CreateCustomGeoTransformation(String geotName,
                                     Object inCoorSystem,
                                     Object outCoorSystem,
                                     String customGeot)
Creates the Create Custom Geographic Transformation 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:
geotName - String, name of the transformation method. All custom geographic transformation files are saved with a *.gtf extension and stored in the users Documents and Settings folder: ...\\Documents and Settings\\Application Data\ESRI\ArcToolbox\CustomTransformations.
inCoorSystem - Coordinate System, specify the starting geographic coordinate system.
outCoorSystem - Coordinate System, specify the final geographic coordinate system.
customGeot - String, specify an existing transformation method from the drop-down list that will be used to transform the data from the input geographic coordinate system to the output geographic coordinate system. Once selected you may customize the methods values.
Method Detail

getGeotName

public String getGeotName()
Returns the Geographic Transformation Name parameter of this tool . This parameter is String, name of the transformation method. All custom geographic transformation files are saved with a *.gtf extension and stored in the users Documents and Settings folder: ...\\Documents and Settings\\Application Data\ESRI\ArcToolbox\CustomTransformations. This is a required parameter.

Returns:
the Geographic Transformation Name

setGeotName

public void setGeotName(String geotName)
Sets the Geographic Transformation Name parameter of this tool . This parameter is String, name of the transformation method. All custom geographic transformation files are saved with a *.gtf extension and stored in the users Documents and Settings folder: ...\\Documents and Settings\\Application Data\ESRI\ArcToolbox\CustomTransformations. This is a required parameter.

Parameters:
geotName - String, name of the transformation method. All custom geographic transformation files are saved with a *.gtf extension and stored in the users Documents and Settings folder: ...\\Documents and Settings\\Application Data\ESRI\ArcToolbox\CustomTransformations.

getInCoorSystem

public Object getInCoorSystem()
Returns the Input Geographic Coordinate System parameter of this tool . This parameter is Coordinate System, specify the starting geographic coordinate system. This is a required parameter.

Returns:
the Input Geographic Coordinate System

setInCoorSystem

public void setInCoorSystem(Object inCoorSystem)
Sets the Input Geographic Coordinate System parameter of this tool . This parameter is Coordinate System, specify the starting geographic coordinate system. This is a required parameter.

Parameters:
inCoorSystem - Coordinate System, specify the starting geographic coordinate system.

getOutCoorSystem

public Object getOutCoorSystem()
Returns the Output Geographic Coordinate System parameter of this tool . This parameter is Coordinate System, specify the final geographic coordinate system. This is a required parameter.

Returns:
the Output Geographic Coordinate System

setOutCoorSystem

public void setOutCoorSystem(Object outCoorSystem)
Sets the Output Geographic Coordinate System parameter of this tool . This parameter is Coordinate System, specify the final geographic coordinate system. This is a required parameter.

Parameters:
outCoorSystem - Coordinate System, specify the final geographic coordinate system.

getCustomGeot

public String getCustomGeot()
Returns the Custom Geographic Transformation parameter of this tool . This parameter is String, specify an existing transformation method from the drop-down list that will be used to transform the data from the input geographic coordinate system to the output geographic coordinate system. Once selected you may customize the methods values. This is a required parameter.

Returns:
the Custom Geographic Transformation

setCustomGeot

public void setCustomGeot(String customGeot)
Sets the Custom Geographic Transformation parameter of this tool . This parameter is String, specify an existing transformation method from the drop-down list that will be used to transform the data from the input geographic coordinate system to the output geographic coordinate system. Once selected you may customize the methods values. This is a required parameter.

Parameters:
customGeot - String, specify an existing transformation method from the drop-down list that will be used to transform the data from the input geographic coordinate system to the output geographic coordinate system. Once selected you may customize the methods values.

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