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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


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 - Layer, 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 Layer, 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 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 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(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.

getDangleOption

public 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(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.

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