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

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

All Implemented Interfaces:

GPTool

public class CalculateGridConvergenceAngle
extends AbstractGPTool

Calculates the rotation angle for true north based on the center point of each feature in a feature class and populates this value in a specified field. This field can be used in conjunction with Data Driven Pages to rotate each map to true north. The Calculate Grid Convergence Angle tool is contained in the Cartography Tools tool box.

Usage tips:

• This tool replaces the Calculate Geodesic Angle tool.

Field Summary

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

vals

Constructor Summary

CalculateGridConvergenceAngle()
Creates the Calculate Grid Convergence Angle tool with defaults.

CalculateGridConvergenceAngle(Object inFeatures, Object angleField)
Creates the Calculate Grid Convergence Angle tool with the required parameters.

Method Summary

Object	getAngleField() Returns the Angle Field parameter of this tool .
Object	getCoordinateSysField() Returns the Coordinate System Field parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
String	getRotationMethod() Returns the Rotation Method 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	setAngleField(Object angleField) Sets the Angle Field parameter of this tool .
void	setCoordinateSysField(Object coordinateSysField) Sets the Coordinate System Field parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setRotationMethod(String rotationMethod) Sets the Rotation Method 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

CalculateGridConvergenceAngle

public CalculateGridConvergenceAngle()

Creates the Calculate Grid Convergence Angle tool with defaults.

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

CalculateGridConvergenceAngle

public CalculateGridConvergenceAngle(Object inFeatures,
                                     Object angleField)

Creates the Calculate Grid Convergence Angle 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 class (points, multipoints, lines, and polygons).

angleField - existing field that will be populated with the true north calculation value in decimal degrees.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is input feature class (points, multipoints, lines, and polygons). 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 class (points, multipoints, lines, and polygons). This is a required parameter.

Parameters:

inFeatures - input feature class (points, multipoints, lines, and polygons).

getAngleField

public Object getAngleField()

Returns the Angle Field parameter of this tool . This parameter is existing field that will be populated with the true north calculation value in decimal degrees. This is a required parameter.

Returns:

the Angle Field

setAngleField

public void setAngleField(Object angleField)

Sets the Angle Field parameter of this tool . This parameter is existing field that will be populated with the true north calculation value in decimal degrees. This is a required parameter.

Parameters:

angleField - existing field that will be populated with the true north calculation value in decimal degrees.

getRotationMethod

public String getRotationMethod()

Returns the Rotation Method parameter of this tool . This parameter is method in which the rotation value is calculated. Geographic is the default value. This is an optional parameter.

Returns:

the Rotation Method

setRotationMethod

public void setRotationMethod(String rotationMethod)

Sets the Rotation Method parameter of this tool . This parameter is method in which the rotation value is calculated. Geographic is the default value. This is an optional parameter.

Parameters:

rotationMethod - method in which the rotation value is calculated. Geographic is the default value.

getCoordinateSysField

public Object getCoordinateSysField()

Returns the Coordinate System Field parameter of this tool . This parameter is field containing a projection engine string for a projected coordinate system to be used for angle calculation. The angle calculation for each feature will be based on the projected coordinate system projection engine string for the specific feature. In cases where there is an invalid value the tool will use the Cartographic Coordinate System specified in the Cartography environment settings. The default is none, or no field specified. When no field is specified the projected coordinate system used for calculation will be taken from the Cartography environment settings. This is an optional parameter.

Returns:

the Coordinate System Field

setCoordinateSysField

public void setCoordinateSysField(Object coordinateSysField)

Sets the Coordinate System Field parameter of this tool . This parameter is field containing a projection engine string for a projected coordinate system to be used for angle calculation. The angle calculation for each feature will be based on the projected coordinate system projection engine string for the specific feature. In cases where there is an invalid value the tool will use the Cartographic Coordinate System specified in the Cartography environment settings. The default is none, or no field specified. When no field is specified the projected coordinate system used for calculation will be taken from the Cartography environment settings. This is an optional parameter.

Parameters:

coordinateSysField - field containing a projection engine string for a projected coordinate system to be used for angle calculation. The angle calculation for each feature will be based on the projected coordinate system projection engine string for the specific feature. In cases where there is an invalid value the tool will use the Cartographic Coordinate System specified in the Cartography environment settings. The default is none, or no field specified. When no field is specified the projected coordinate system used for calculation will be taken from the Cartography environment settings.

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