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

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

All Implemented Interfaces:

GPTool

public class CalculateLineCaps

extends AbstractGPTool

Calculates the cap type (ending style) for double-line symbols in the input representations. The Calculate Line Caps tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• The line cap type defines how the ends of line segments are drawn using a double-line symbol. By default a round line cap will be used, meaning the symbol is terminated with a semicircle centered at the line endpoint and having a radius equal to the line symbol width or thickness. You can use this tool to change the cap type to BUTT or SQUARE. For BUTT caps, the symbol ends where line endpoints end. For SQUARE caps, the double-line symbol extends past the endpoint of the line by half of the symbol width and close with a squared shape.
• The calculated cap types will be stored as representation property overrides. To change back to round caps, you can just remove the representation property overrides using the Remove Override; tool.
• The dangle options are very specific. The TRUE_DANGLE means the end of a linear feature, for example, the dead-end of a road. When this option is used, the tool will calculate line caps for true dangles only. The CASED_LINE_DANGLE is where a linear feature still continues, but the representation changes from a double-line or cased-line symbol to a single-line symbol. When this option is used, the tool will calculate line caps for both true dangles and cased-line dangles.

Field Summary

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

vals

Constructor Summary

CalculateLineCaps()
Creates the Calculate Line Caps tool with defaults.

CalculateLineCaps(java.lang.Object inFeatures)
Creates the Calculate Line Caps tool with the required parameters.

Method Summary

java.lang.String	getCapType() Returns the Cap Type parameter of this tool .
java.lang.String	getDangleOption() Returns the Dangle Option parameter of this tool .
java.lang.Object	getInFeatures() Returns the Input Features With Representations parameter of this tool .
java.lang.Object	getOutRepresentations() Returns the Output Representations parameter of this tool (Read only).
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setCapType(java.lang.String capType) Sets the Cap Type parameter of this tool .
void	setDangleOption(java.lang.String dangleOption) Sets the Dangle Option parameter of this tool .
void	setInFeatures(java.lang.Object inFeatures) Sets the Input Features With Representations 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

CalculateLineCaps

public CalculateLineCaps()

Creates the Calculate Line Caps tool with defaults.

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

CalculateLineCaps

public CalculateLineCaps(java.lang.Object inFeatures)

Creates the Calculate Line Caps 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 representations.

Method Detail

getInFeatures

public java.lang.Object getInFeatures()

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

Returns:

the Input Features With Representations

setInFeatures

public void setInFeatures(java.lang.Object inFeatures)

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

Parameters:

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

getCapType

public java.lang.String getCapType()

Returns the Cap Type parameter of this tool . This parameter is String, specifies the cap type for double-line representation symbol. This is an optional parameter.

Returns:

the Cap Type

setCapType

public void setCapType(java.lang.String capType)

Sets the Cap Type parameter of this tool . This parameter is String, specifies the cap type for double-line representation symbol. This is an optional parameter.

Parameters:

capType - String, specifies the cap type for double-line representation symbol.

• BUTT—specifies to end the double-line symbol exactly where the line ends. This is the default.
• SQUARE—specifies to close the double-line symbol with a squared shape. The symbol extends past the endpoint of the line by half of the symbol width.

getDangleOption

public java.lang.String getDangleOption()

Returns the Dangle Option parameter of this tool . This parameter is String, specifies the dangle option for line cap calculation. This is an optional parameter.

Returns:

the Dangle Option

setDangleOption

public void setDangleOption(java.lang.String dangleOption)

Sets the Dangle Option parameter of this tool . This parameter is String, specifies the dangle option for line cap calculation. This is an optional parameter.

Parameters:

dangleOption - String, specifies the dangle option for line cap calculation.

• CASED_LINE_DANGLE—Specifies to calculate not only true dangles but also where a cased-line symbol meets a single-line symbol. This is the default.
• TRUE_DANGLE—Specifies to calculate true dangles only.

getOutRepresentations

public java.lang.Object getOutRepresentations()

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

Returns:

the Output Representations

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias