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

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

public class SmoothLine
extends AbstractGPTool

Smooths a line to improve its aesthetic or cartographic quality. The Smooth Line tool is contained in the Cartography Tools tool box.
Learn more about how Smooth Line works

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
SmoothLine()
          Creates the Smooth Line tool with defaults.
SmoothLine(Object inFeatures, Object outFeatureClass, String algorithm, Object tolerance)
          Creates the Smooth Line tool with the required parameters.
 
Method Summary
 String getAlgorithm()
          Returns the Smoothing Algorithm parameter of this tool .
 String getEndpointOption()
          Returns the Preseve endpoint for closed lines parameter of this tool .
 String getErrorOption()
          Returns the Handling Topological Errors parameter of this tool .
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 Object getTolerance()
          Returns the Smoothing Tolerance parameter of this tool .
 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 setAlgorithm(String algorithm)
          Sets the Smoothing Algorithm parameter of this tool .
 void setEndpointOption(String endpointOption)
          Sets the Preseve endpoint for closed lines parameter of this tool .
 void setErrorOption(String errorOption)
          Sets the Handling Topological Errors parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setTolerance(Object tolerance)
          Sets the Smoothing Tolerance 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

SmoothLine

public SmoothLine()
Creates the Smooth Line tool with defaults.

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


SmoothLine

public SmoothLine(Object inFeatures,
                  Object outFeatureClass,
                  String algorithm,
                  Object tolerance)
Creates the Smooth Line 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 line features to be smoothed.
outFeatureClass - Feature Class, the output feature class to be created.
algorithm - String, specifies the line smoothing algorithm.
  • PAEK—Stands for Polynomial Approximation with Exponential Kernel. It calculates a smoothed line that will not pass through the input line vertices. This is the default.
  • BEZIER_INTERPOLATION—Fits Bezier curves between vertices. The resulting line passes through the vertices of the input line. This algorithm does not require a tolerance.
tolerance - Linear Unit, sets a tolerance used by the PAEK algorithm. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.
Method Detail

getInFeatures

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

Parameters:
inFeatures - Feature Layer, the line features to be smoothed.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to be created. This is a required parameter.

Returns:
the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to be created. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the output feature class to be created.

getAlgorithm

public String getAlgorithm()
Returns the Smoothing Algorithm parameter of this tool . This parameter is String, specifies the line smoothing algorithm. This is a required parameter.

Returns:
the Smoothing Algorithm

setAlgorithm

public void setAlgorithm(String algorithm)
Sets the Smoothing Algorithm parameter of this tool . This parameter is String, specifies the line smoothing algorithm. This is a required parameter.

Parameters:
algorithm - String, specifies the line smoothing algorithm.
  • PAEK—Stands for Polynomial Approximation with Exponential Kernel. It calculates a smoothed line that will not pass through the input line vertices. This is the default.
  • BEZIER_INTERPOLATION—Fits Bezier curves between vertices. The resulting line passes through the vertices of the input line. This algorithm does not require a tolerance.

getTolerance

public Object getTolerance()
Returns the Smoothing Tolerance parameter of this tool . This parameter is Linear Unit, sets a tolerance used by the PAEK algorithm. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit. This is a required parameter.

Returns:
the Smoothing Tolerance

setTolerance

public void setTolerance(Object tolerance)
Sets the Smoothing Tolerance parameter of this tool . This parameter is Linear Unit, sets a tolerance used by the PAEK algorithm. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit. This is a required parameter.

Parameters:
tolerance - Linear Unit, sets a tolerance used by the PAEK algorithm. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.

getEndpointOption

public String getEndpointOption()
Returns the Preseve endpoint for closed lines parameter of this tool . This parameter is String, specifies whether to preserve the endpoints for closed lines. This option works with the PAEK algorithm only. This is an optional parameter.

Returns:
the Preseve endpoint for closed lines

setEndpointOption

public void setEndpointOption(String endpointOption)
Sets the Preseve endpoint for closed lines parameter of this tool . This parameter is String, specifies whether to preserve the endpoints for closed lines. This option works with the PAEK algorithm only. This is an optional parameter.

Parameters:
endpointOption - String, specifies whether to preserve the endpoints for closed lines. This option works with the PAEK algorithm only.
  • FIXED_CLOSED_ENDPOINT—Preserves the endpoint of a closed line. This is the default.
  • NO_FIXED—Smooths through the endpoint of a closed line.

getErrorOption

public String getErrorOption()
Returns the Handling Topological Errors parameter of this tool . This parameter is String, specifies how the topological errors (possibly introduced in the process, such as line crossing) will be handled. This is an optional parameter.

Returns:
the Handling Topological Errors

setErrorOption

public void setErrorOption(String errorOption)
Sets the Handling Topological Errors parameter of this tool . This parameter is String, specifies how the topological errors (possibly introduced in the process, such as line crossing) will be handled. This is an optional parameter.

Parameters:
errorOption - String, specifies how the topological errors (possibly introduced in the process, such as line crossing) will be handled.
  • NO_CHECK—Specifies not to check for topological errors. This is the default.
  • FLAG_ERRORS—Specifies to flag topological errors, if any are found.

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