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

Modifies the cap type (ending style) for representation stroke symbols and stores it as an override. The Calculate Line Caps tool is contained in the Cartography Tools tool box.

Usage tips:

• Representation stroke symbols that are relatively wide and drawn with multiple layers to display a "cased road" effect are often joined together at their endpoints with round line caps to prevent symbol gaps appearing at sharp angles between features. However, a round end cap is generally not desirable cartographic appearance for dead-end street (dangling line features that are not connected at their endpoint to another feature.) The line cap style is generally overriden to a butt or square style in these situations. This tool detects dangles and overrides the representation cap type of the stroke symbol.

Field Summary

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

vals

Constructor Summary

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

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

Method Summary

String	getCapType() Returns the Cap Type parameter of this tool .
String	getDangleOption() Returns the Dangle Option parameter of this tool .
Object	getInFeatures() Returns the Input Features With Representations 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	setCapType(String capType) Sets the Cap Type parameter of this tool .
void	setDangleOption(String dangleOption) Sets the Dangle Option parameter of this tool .
void	setInFeatures(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(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 - the input feature layer containing line representations.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features With Representations parameter of this tool . This parameter is the input feature layer containing line 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 the input feature layer containing line representations. This is a required parameter.

Parameters:

inFeatures - the input feature layer containing line representations.

getCapType

public String getCapType()

Returns the Cap Type parameter of this tool . This parameter is defines how the ends of representation stroke symbols are drawn. The default cap type of representation strokes is round, where the symbol is terminated with a semicircle of radius equal to stroke width is centered at the line endpoint. This tool changes cap type to BUTT or SQUARE. This is an optional parameter.

Returns:

the Cap Type

setCapType

public void setCapType(String capType)

Sets the Cap Type parameter of this tool . This parameter is defines how the ends of representation stroke symbols are drawn. The default cap type of representation strokes is round, where the symbol is terminated with a semicircle of radius equal to stroke width is centered at the line endpoint. This tool changes cap type to BUTT or SQUARE. This is an optional parameter.

Parameters:

capType - defines how the ends of representation stroke symbols are drawn. The default cap type of representation strokes is round, where the symbol is terminated with a semicircle of radius equal to stroke width is centered at the line endpoint. This tool changes cap type to BUTT or SQUARE.

getDangleOption

public String getDangleOption()

Returns the Dangle Option parameter of this tool . This parameter is the Dangle parameter controls how line caps are calculated for adjoining line features that share an endpoint but are drawn with different representation symbology. This is an optional parameter.

Returns:

the Dangle Option

setDangleOption

public void setDangleOption(String dangleOption)

Sets the Dangle Option parameter of this tool . This parameter is the Dangle parameter controls how line caps are calculated for adjoining line features that share an endpoint but are drawn with different representation symbology. This is an optional parameter.

Parameters:

dangleOption - the Dangle parameter controls how line caps are calculated for adjoining line features that share an endpoint but are drawn with different representation symbology.

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