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

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

public class CollapseDualLinesToCenterline
extends AbstractGPTool

Derives centerlines from dual-line (or double-line) features, such as road casings, based on specified width tolerances. The Collapse Dual Lines To Centerline tool is contained in the Data Management Tools tool box.

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 inFeatures, Object outFeatureClass, Object maximumWidth)
          Creates the Collapse Dual Lines To Centerline tool with the required parameters.
 
Method Summary
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 Object getMaximumWidth()
          Returns the Maximum Width parameter of this tool .
 Object getMinimumWidth()
          Returns the Minimum Width parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class 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 setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setMaximumWidth(Object maximumWidth)
          Sets the Maximum Width parameter of this tool .
 void setMinimumWidth(Object minimumWidth)
          Sets the Minimum Width parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class 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 inFeatures,
                                     Object outFeatureClass,
                                     Object 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:
inFeatures - Feature Layer, the input dual-line features, such as road casings, from which centerlines are derived.
outFeatureClass - Feature Class, the output feature class to be created.
maximumWidth - Linear Unit, sets the maximum width of the dual-line features to derive centerline. A value 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 input dual-line features, such as road casings, from which centerlines are derived. 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 input dual-line features, such as road casings, from which centerlines are derived. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the input dual-line features, such as road casings, from which centerlines are derived.

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.

getMaximumWidth

public Object getMaximumWidth()
Returns the Maximum Width parameter of this tool . This parameter is Linear Unit, sets the maximum width of the dual-line features to derive centerline. A value 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 Maximum Width

setMaximumWidth

public void setMaximumWidth(Object maximumWidth)
Sets the Maximum Width parameter of this tool . This parameter is Linear Unit, sets the maximum width of the dual-line features to derive centerline. A value 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:
maximumWidth - Linear Unit, sets the maximum width of the dual-line features to derive centerline. A value must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.

getMinimumWidth

public Object getMinimumWidth()
Returns the Minimum Width parameter of this tool . This parameter is Linear Unit, sets the minimum width of the dual-line features to derive centerline. The minimum width must be greater than or equal to zero, and it must be less than the maximum width. The default value is zero. You can specify a preferred unit; the default is the feature unit. This is an optional parameter.

Returns:
the Minimum Width

setMinimumWidth

public void setMinimumWidth(Object minimumWidth)
Sets the Minimum Width parameter of this tool . This parameter is Linear Unit, sets the minimum width of the dual-line features to derive centerline. The minimum width must be greater than or equal to zero, and it must be less than the maximum width. The default value is zero. You can specify a preferred unit; the default is the feature unit. This is an optional parameter.

Parameters:
minimumWidth - Linear Unit, sets the minimum width of the dual-line features to derive centerline. The minimum width must be greater than or equal to zero, and it must be less than the maximum width. The default value is zero. You can specify a preferred unit; the default is the feature unit.

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