com.esri.arcgis.geoprocessing.tools.coveragetools
Class CollapseDualLinesToCenterline

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

public class CollapseDualLinesToCenterline
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Derives centerlines (single lines) from dual-line features, such as road casings, based on specified width tolerances. The Collapse Dual Lines To Centerline tool is contained in the Coverage Tools tool box.
Learn more about how Collapse Dual Lines To Centerline works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CollapseDualLinesToCenterline()
          Creates the Collapse Dual Lines To Centerline tool with defaults.
CollapseDualLinesToCenterline(Object inCover, Object outCover, double maximumWidth)
          Creates the Collapse Dual Lines To Centerline tool with the required parameters.
 
Method Summary
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 double getMaximumWidth()
          Returns the Maximum Width parameter of this tool .
 double getMinimumWidth()
          Returns the Minimum Width parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage 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 setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setMaximumWidth(double maximumWidth)
          Sets the Maximum Width parameter of this tool .
 void setMinimumWidth(double minimumWidth)
          Sets the Minimum Width parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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

CollapseDualLinesToCenterline

public CollapseDualLinesToCenterline()
Creates the Collapse Dual Lines To Centerline tool with defaults.

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


CollapseDualLinesToCenterline

public CollapseDualLinesToCenterline(Object inCover,
                                     Object outCover,
                                     double maximumWidth)
Creates the Collapse Dual Lines To Centerline 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:
inCover - Coverage, the coverage containing near parallel dual lines, such as road casings, from which centerlines are derived.
outCover - Coverage, the output coverage containing the derived centerlines. The output coverage name must be different from the input coverage name.
maximumWidth - Double, sets the maximum width in coverage units.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing near parallel dual lines, such as road casings, from which centerlines are derived. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing near parallel dual lines, such as road casings, from which centerlines are derived. This is a required parameter.

Parameters:
inCover - Coverage, the coverage containing near parallel dual lines, such as road casings, from which centerlines are derived.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the output coverage containing the derived centerlines. The output coverage name must be different from the input coverage name. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the output coverage containing the derived centerlines. The output coverage name must be different from the input coverage name. This is a required parameter.

Parameters:
outCover - Coverage, the output coverage containing the derived centerlines. The output coverage name must be different from the input coverage name.

getMaximumWidth

public double getMaximumWidth()
Returns the Maximum Width parameter of this tool . This parameter is Double, sets the maximum width in coverage units. This is a required parameter.

Returns:
the Maximum Width

setMaximumWidth

public void setMaximumWidth(double maximumWidth)
Sets the Maximum Width parameter of this tool . This parameter is Double, sets the maximum width in coverage units. This is a required parameter.

Parameters:
maximumWidth - Double, sets the maximum width in coverage units.

getMinimumWidth

public double getMinimumWidth()
Returns the Minimum Width parameter of this tool . This parameter is Double, sets the minimum width in coverage units. The default is zero. This is an optional parameter.

Returns:
the Minimum Width

setMinimumWidth

public void setMinimumWidth(double minimumWidth)
Sets the Minimum Width parameter of this tool . This parameter is Double, sets the minimum width in coverage units. The default is zero. This is an optional parameter.

Parameters:
minimumWidth - Double, sets the minimum width in coverage units. The default is zero.

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