com.esri.arcgis.geoprocessing.tools.cartographytools
Class CalculateUTMZone

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.CalculateUTMZone

All Implemented Interfaces:

GPTool

public class CalculateUTMZone
extends AbstractGPTool

Calculates a UTM zone of each feature based on the center point and stores this spatial reference string in a specified field. This field can be used in conjunction with Data Driven Pages to update the spatial reference to the correct UTM zone for each map. The Calculate UTM Zone tool is contained in the Cartography Tools tool box.

Usage tips:

• Input features can be points, lines, or polygons.
• Geometries located at extreme latitudes, near either the North or the South poles, may not be appropriate for UTM zone calculation. You will receive a warning when a UTM zone cannot be calculated for a particular feature.
• The datum for the calculated UTM coordinate system string is taken from the datum of the active data frame's coordinate system. If the datum of the feature's data source is different than the data frame's, you will get a warning. A UTM zone is calculated, however, the result may not be accurate. The tool does not perform any geotransformations. In order to get the best results, the datum of your input features should be the same as the datum used by the data frame.
• The UTM Zone Field, which contains the UTM spatial reference string, should have a length of 600 characters or more. Spatial reference strings vary in length but are usually quite long, and you need to ensure that the field has enough space. The tool will issue a warning if the spatial reference string has been truncated because the field length is not long enough. If you get this warning, it is likely that some of the spatial reference strings generated may have been truncated making them useless. When receiving the warning you should delete your results, create a new field of a sufficient length (> 600 characters), and rerun the tool.
• Use geodatabase feature classes. In most cases, the field size limitation of shapefiles makes it likely that spatial reference strings will be truncated if you run this tool on a shapefile.

Field Summary

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

vals

Constructor Summary

CalculateUTMZone()
Creates the Calculate UTM Zone tool with defaults.

CalculateUTMZone(Object inFeatures, Object inField)
Creates the Calculate UTM Zone tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getInField() Returns the UTM Zone Field parameter of this tool .
Object	getOutFeatures() Returns the Output Features 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	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setInField(Object inField) Sets the UTM Zone Field 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

CalculateUTMZone

public CalculateUTMZone()

Creates the Calculate UTM Zone tool with defaults.

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

CalculateUTMZone

public CalculateUTMZone(Object inFeatures,
                        Object inField)

Creates the Calculate UTM Zone 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:

inFeatures - input feature layer.

inField - string field that stores the spatial reference string for the coordinate system. Field should have sufficient length (more than 600 characters) to hold the spatial reference string.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is input feature layer. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is input feature layer. This is a required parameter.

Parameters:

inFeatures - input feature layer.

getInField

public Object getInField()

Returns the UTM Zone Field parameter of this tool . This parameter is string field that stores the spatial reference string for the coordinate system. Field should have sufficient length (more than 600 characters) to hold the spatial reference string. This is a required parameter.

Returns:

the UTM Zone Field

setInField

public void setInField(Object inField)

Sets the UTM Zone Field parameter of this tool . This parameter is string field that stores the spatial reference string for the coordinate system. Field should have sufficient length (more than 600 characters) to hold the spatial reference string. This is a required parameter.

Parameters:

inField - string field that stores the spatial reference string for the coordinate system. Field should have sufficient length (more than 600 characters) to hold the spatial reference string.

getOutFeatures

public Object getOutFeatures()

Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Features

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