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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.MergeDividedRoads

All Implemented Interfaces:

GPTool

public class MergeDividedRoads
extends AbstractGPTool

Generates single line road features in place of matched pairs of divided road lanes. The Merge Divided Roads tool is contained in the Cartography Tools tool box.

Usage tips:

• The output feature class contains single line features representing merged roads and copies of all unmerged input features. Merged features will inherit the attribution from one of the two input features.
• Input features with Merge Field parameter values equal to zero are "locked" and will not be merged, even if adjacent features are not locked.
• The optional Output Displacement Feature Class parameter creates a feature class of polygons that indicates the amount and direction of displacement that took place. This feature class can be used for visual inspection, for spatial querying, or as an input to the tool.
• If the input is a feature layer drawn with a representation, any shape overrides associated with the representation will be used as the input geometry considered by this tool and the corresponding geometry in the Shape field will be ignored. The output feature class will contain the feature class representation, but all geometry will be stored in the output Shape field, not as representation shape overrides.

Field Summary

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

vals

Constructor Summary

MergeDividedRoads()
Creates the Merge Divided Roads tool with defaults.

MergeDividedRoads(Object inFeatures, Object mergeField, Object mergeDistance, Object outFeatures)
Creates the Merge Divided Roads tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getMergeDistance() Returns the Merge Distance parameter of this tool .
Object	getMergeField() Returns the Merge Field parameter of this tool .
Object	getOutDisplacementFeatures() Returns the Output Displacement Feature Class parameter of this tool .
Object	getOutFeatures() Returns the Output Features 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	setMergeDistance(Object mergeDistance) Sets the Merge Distance parameter of this tool .
void	setMergeField(Object mergeField) Sets the Merge Field parameter of this tool .
void	setOutDisplacementFeatures(Object outDisplacementFeatures) Sets the Output Displacement Feature Class parameter of this tool .
void	setOutFeatures(Object outFeatures) Sets the Output Features 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

MergeDividedRoads

public MergeDividedRoads()

Creates the Merge Divided Roads tool with defaults.

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

MergeDividedRoads

public MergeDividedRoads(Object inFeatures,
                         Object mergeField,
                         Object mergeDistance,
                         Object outFeatures)

Creates the Merge Divided Roads 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 linear road features that contain matched pairs of divided road lanes which should be merged together to a single output line feature.

mergeField - the field that contains road classification information. Only parallel, proximate roads of equal classification will be merged. A value of 0 (zero) locks a feature to prevent it from participating in merging.

mergeDistance - the minimum distance apart, in the specified units, for equal-class, relatively parallel road features to be merged. This distance must be greater than zero. If the units are in pt, mm, cm, or in, the value is considered as page units and takes into account the reference scale.

outFeatures - the output feature class containing single line merged road features and all unmerged road features.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input linear road features that contain matched pairs of divided road lanes which should be merged together to a single output line feature. 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 the input linear road features that contain matched pairs of divided road lanes which should be merged together to a single output line feature. This is a required parameter.

Parameters:

inFeatures - the input linear road features that contain matched pairs of divided road lanes which should be merged together to a single output line feature.

getMergeField

public Object getMergeField()

Returns the Merge Field parameter of this tool . This parameter is the field that contains road classification information. Only parallel, proximate roads of equal classification will be merged. A value of 0 (zero) locks a feature to prevent it from participating in merging. This is a required parameter.

Returns:

the Merge Field

setMergeField

public void setMergeField(Object mergeField)

Sets the Merge Field parameter of this tool . This parameter is the field that contains road classification information. Only parallel, proximate roads of equal classification will be merged. A value of 0 (zero) locks a feature to prevent it from participating in merging. This is a required parameter.

Parameters:

mergeField - the field that contains road classification information. Only parallel, proximate roads of equal classification will be merged. A value of 0 (zero) locks a feature to prevent it from participating in merging.

getMergeDistance

public Object getMergeDistance()

Returns the Merge Distance parameter of this tool . This parameter is the minimum distance apart, in the specified units, for equal-class, relatively parallel road features to be merged. This distance must be greater than zero. If the units are in pt, mm, cm, or in, the value is considered as page units and takes into account the reference scale. This is a required parameter.

Returns:

the Merge Distance

setMergeDistance

public void setMergeDistance(Object mergeDistance)

Sets the Merge Distance parameter of this tool . This parameter is the minimum distance apart, in the specified units, for equal-class, relatively parallel road features to be merged. This distance must be greater than zero. If the units are in pt, mm, cm, or in, the value is considered as page units and takes into account the reference scale. This is a required parameter.

Parameters:

mergeDistance - the minimum distance apart, in the specified units, for equal-class, relatively parallel road features to be merged. This distance must be greater than zero. If the units are in pt, mm, cm, or in, the value is considered as page units and takes into account the reference scale.

getOutFeatures

public Object getOutFeatures()

Returns the Output Features parameter of this tool . This parameter is the output feature class containing single line merged road features and all unmerged road features. This is a required parameter.

Returns:

the Output Features

setOutFeatures

public void setOutFeatures(Object outFeatures)

Sets the Output Features parameter of this tool . This parameter is the output feature class containing single line merged road features and all unmerged road features. This is a required parameter.

Parameters:

outFeatures - the output feature class containing single line merged road features and all unmerged road features.

getOutDisplacementFeatures

public Object getOutDisplacementFeatures()

Returns the Output Displacement Feature Class parameter of this tool . This parameter is the output polygon features containing the degree and direction of road displacement, to be used by the Propagate Displacement tool to preserve spatial relationships. This is an optional parameter.

Returns:

the Output Displacement Feature Class

setOutDisplacementFeatures

public void setOutDisplacementFeatures(Object outDisplacementFeatures)

Sets the Output Displacement Feature Class parameter of this tool . This parameter is the output polygon features containing the degree and direction of road displacement, to be used by the Propagate Displacement tool to preserve spatial relationships. This is an optional parameter.

Parameters:

outDisplacementFeatures - the output polygon features containing the degree and direction of road displacement, to be used by the Propagate Displacement tool to preserve spatial relationships.

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