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

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

All Implemented Interfaces:

GPTool

public class CalculateGeodesicAngle
extends AbstractGPTool

Calculates geodesic angles for the input features according to the defined coordinate system, and assigns the angle values to the specified field in the feature class that contains the input features. The Calculate Geodesic Angle tool is contained in the Cartography Tools tool box.

Usage tips:

• Angles are calculated according to the coordinate system of the active data frame of the current map document or the Coordinate System geoprocessing environment variable, if it is set. This environment setting must be set to execute the tool from ArcCatalog.
• The input features can be points, lines, or polygons. For a point feature, the point location will be used to calculate the geodesic angle. For a line or polygon feature, the center point (centroid) of geometry will be used to calculate the geodesic angle.
• A field must be present in the input feature attribute table to store the calculated angles. The stored angles are in decimal degrees.

Field Summary

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

vals

Constructor Summary

CalculateGeodesicAngle()
Creates the Calculate Geodesic Angle tool with defaults.

CalculateGeodesicAngle(Object inFeatures, Object angleField)
Creates the Calculate Geodesic Angle tool with the required parameters.

Method Summary

Object	getAngleField() Returns the Angle 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	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	setInFeatures(Object inFeatures) Sets the Input Features 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

CalculateGeodesicAngle

public CalculateGeodesicAngle()

Creates the Calculate Geodesic Angle tool with defaults.

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

CalculateGeodesicAngle

public CalculateGeodesicAngle(Object inFeatures,
                              Object angleField)

Creates the Calculate Geodesic 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 - the input features for which geodesic angles will be computed.

angleField - the field that will be updated with the geodesic angle values in decimal degrees.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input features for which geodesic angles will be computed. 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 the input features for which geodesic angles will be computed. This is a required parameter.

Parameters:

inFeatures - the input features for which geodesic angles will be computed.

getAngleField

public Object getAngleField()

Returns the Angle Field parameter of this tool . This parameter is the field that will be updated with the geodesic angle values 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 the field that will be updated with the geodesic angle values in decimal degrees. This is a required parameter.

Parameters:

angleField - the field that will be updated with the geodesic angle values in decimal degrees.

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