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

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

All Implemented Interfaces:

GPTool

public class CalculateCentralMeridianAndParallels
extends AbstractGPTool

Calculates the central meridian and optional standard parallels based on the center point of a feature's extent; stores this coordinate system as a spatial reference string in a specified text field and repeats this for a set, or subset, of features. The Calculate Central Meridian and Parallels tool is contained in the Cartography Tools tool box.

Usage tips:

• Input features can be points, lines, or polygons
• Running this tool directly against a feature class that does not have a projection results in an error. The feature class must be projected.
• If you are using the tool while ArcMap is open, the resulting spatial reference string will be based on the current projection of the active data frame. The data frame must be in a projected coordinate system for the tool to work;otherwise, you will receive an error message. Input features can be projected on the fly.
• Data Driven Pages can use this string field to update the data frame coordinate system for each page.
• The Coordinate System Field must be a text field and should have a length of 600 characters or more. Coordinate system 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 coordinate system string has been truncated because the field length is not long enough. If you get this warning, it is likely that some of the coordinate system 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 PE strings will be truncated if you run this tool on a shapefile.
• The Standard Parallel Offset is a percentage of the latitudinal height extent of the input feature. The offset from the latitude of the center of the input feature is calculated using this percentage. A Standard Parallel Offset value of 0 results in parallel values equal to the latitude of the input feature latitudinal center. A value of 0.5 (50%) results in parallels approximate to the latitudinal height, with parallels at the top and the bottom, of the feature. Values greater than 0.5 will place the parallels outside the latitudinal bounds of the input feature. The default value is 0.25. This places the parallels approximately halfway from the latitudinal center of the feature and its latitudinal edges.

Field Summary

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

vals

Constructor Summary

CalculateCentralMeridianAndParallels()
Creates the Calculate Central Meridian and Parallels tool with defaults.

CalculateCentralMeridianAndParallels(Object inFeatures, Object inField)
Creates the Calculate Central Meridian and Parallels tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getInField() Returns the Coordinate System Field parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
double	getStandardOffset() Returns the Standard Parallel Offset 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	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setInField(Object inField) Sets the Coordinate System Field parameter of this tool .
void	setStandardOffset(double standardOffset) Sets the Standard Parallel Offset 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

CalculateCentralMeridianAndParallels

public CalculateCentralMeridianAndParallels()

Creates the Calculate Central Meridian and Parallels tool with defaults.

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

CalculateCentralMeridianAndParallels

public CalculateCentralMeridianAndParallels(Object inFeatures,
                                            Object inField)

Creates the Calculate Central Meridian and Parallels 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 - text field to store the coordinate system 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 Coordinate System Field parameter of this tool . This parameter is text field to store the coordinate system string. This is a required parameter.

Returns:

the Coordinate System Field

setInField

public void setInField(Object inField)

Sets the Coordinate System Field parameter of this tool . This parameter is text field to store the coordinate system string. This is a required parameter.

Parameters:

inField - text field to store the coordinate system string.

getStandardOffset

public double getStandardOffset()

Returns the Standard Parallel Offset parameter of this tool . This parameter is percentage of the height of the input feature used to offset the standard parallels from the center latitude of the input feature. The default is 25% or 0.25. This is an optional parameter.

Returns:

the Standard Parallel Offset

setStandardOffset

public void setStandardOffset(double standardOffset)

Sets the Standard Parallel Offset parameter of this tool . This parameter is percentage of the height of the input feature used to offset the standard parallels from the center latitude of the input feature. The default is 25% or 0.25. This is an optional parameter.

Parameters:

standardOffset - percentage of the height of the input feature used to offset the standard parallels from the center latitude of the input feature. The default is 25% or 0.25.

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