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

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

All Implemented Interfaces:

GPTool

public class SetRepresentationControlPointByAngle
extends AbstractGPTool

Finds a vertex along a line or polygon boundary where the inner angle is equal to or less than the specified Maximum Angle, sets the vertex as a The Set Representation Control Point By Angle tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Usage tips:

• An inner angle is the angle between the two line segments, measured less than 180 degrees, at a vertex. The smaller the inner angle is, the sharper turn it indicates.
• A vertex with its inner angle less than or equal to the specified maximum angle will be set as a representation control point.

Field Summary

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

vals

Constructor Summary

SetRepresentationControlPointByAngle()
Creates the Set Representation Control Point By Angle tool with defaults.

SetRepresentationControlPointByAngle(Object inFeatures, double maximumAngle)
Creates the Set Representation Control Point By Angle tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features With Representations parameter of this tool .
double	getMaximumAngle() Returns the Maximum Angle (decimal degrees) parameter of this tool .
Object	getOutRepresentations() Returns the Output Representations 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 With Representations parameter of this tool .
void	setMaximumAngle(double maximumAngle) Sets the Maximum Angle (decimal degrees) 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

SetRepresentationControlPointByAngle

public SetRepresentationControlPointByAngle()

Creates the Set Representation Control Point By Angle tool with defaults.

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

SetRepresentationControlPointByAngle

public SetRepresentationControlPointByAngle(Object inFeatures,
                                            double maximumAngle)

Creates the Set Representation Control Point By 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 - Layer, the input feature layer containing line or polygon representations.

maximumAngle - Double, the angle used to determine whether or not a vertex along a line or polygon boundary will be set as a representation control point. The angle value must be greater than zero and less than 180 decimal degrees.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features With Representations parameter of this tool . This parameter is Layer, the input feature layer containing line or polygon representations. This is a required parameter.

Returns:

the Input Features With Representations

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features With Representations parameter of this tool . This parameter is Layer, the input feature layer containing line or polygon representations. This is a required parameter.

Parameters:

inFeatures - Layer, the input feature layer containing line or polygon representations.

getMaximumAngle

public double getMaximumAngle()

Returns the Maximum Angle (decimal degrees) parameter of this tool . This parameter is Double, the angle used to determine whether or not a vertex along a line or polygon boundary will be set as a representation control point. The angle value must be greater than zero and less than 180 decimal degrees. This is a required parameter.

Returns:

the Maximum Angle (decimal degrees)

setMaximumAngle

public void setMaximumAngle(double maximumAngle)

Sets the Maximum Angle (decimal degrees) parameter of this tool . This parameter is Double, the angle used to determine whether or not a vertex along a line or polygon boundary will be set as a representation control point. The angle value must be greater than zero and less than 180 decimal degrees. This is a required parameter.

Parameters:

maximumAngle - Double, the angle used to determine whether or not a vertex along a line or polygon boundary will be set as a representation control point. The angle value must be greater than zero and less than 180 decimal degrees.

getOutRepresentations

public Object getOutRepresentations()

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

Returns:

the Output Representations

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