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

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

public class CalculatePolygonMainAngle
extends AbstractGPTool

Calculates the main angles of the input polygon features and assigns the angle values to the specified field in the feature class that contains the polygon features. The Calculate Polygon Main Angle tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculatePolygonMainAngle()
          Creates the Calculate Polygon Main Angle tool with defaults.
CalculatePolygonMainAngle(Object inFeatures, Object angleField)
          Creates the Calculate Polygon Main 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

CalculatePolygonMainAngle

public CalculatePolygonMainAngle()
Creates the Calculate Polygon Main Angle tool with defaults.

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


CalculatePolygonMainAngle

public CalculatePolygonMainAngle(Object inFeatures,
                                 Object angleField)
Creates the Calculate Polygon Main 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 - Feature Layer, the input polygon features.
angleField - Field, the field that will be updated with the polygon main angle values.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the input polygon features. 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 Feature Layer, the input polygon features. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the input polygon features.

getAngleField

public Object getAngleField()
Returns the Angle Field parameter of this tool . This parameter is Field, the field that will be updated with the polygon main angle values. 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 Field, the field that will be updated with the polygon main angle values. This is a required parameter.

Parameters:
angleField - Field, the field that will be updated with the polygon main angle values.

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