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

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

All Implemented Interfaces:

GPTool

public class PropagateDisplacement
extends AbstractGPTool

Propagates the displacement resulting from road adjustment in the Resolve Road Conflicts and Merge Divided Roads tools to adjacent features. The Propagate Displacement tool is contained in the Cartography Tools tool box.

Usage tips:

• The location of input features are adjusted based on the vector displacements contained in the displacement features. Adjustments are a compromise of all displacements, such that large displacements that occurred quite near an input feature will have more influence than smaller displacements further away. Conceptually, this action is similar to a rubber-sheeting process that moves features in various directions by various amounts to fit them back to the spatial relationship that they originally had with the roads.
• This tool does not resolve graphic conflicts and in fact may introduce new conflicts. Topological errors that are introduced can be inspected using the tool. If you are using this tool to propagate displacement to building features, consider running the tool after propagation.
• This tool operates by assessing graphic conflicts of symbolized features. The symbology extent and the reference scale are considered in conjunction with one another. Run this tool only after you have finalized the appearance of your symbols, and ensure that the reference scale corresponds to the final intended output scale.

Field Summary

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

vals

Constructor Summary

PropagateDisplacement()
Creates the Propagate Displacement tool with defaults.

PropagateDisplacement(java.lang.Object inFeatures, java.lang.Object displacementFeatures, java.lang.String adjustmentStyle)
Creates the Propagate Displacement tool with the required parameters.

Method Summary

java.lang.String	getAdjustmentStyle() Returns the Adjustment Style parameter of this tool .
java.lang.Object	getDisplacementFeatures() Returns the Displacement Features parameter of this tool .
java.lang.Object	getInFeatures() Returns the Input Features parameter of this tool .
java.lang.Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setAdjustmentStyle(java.lang.String adjustmentStyle) Sets the Adjustment Style parameter of this tool .
void	setDisplacementFeatures(java.lang.Object displacementFeatures) Sets the Displacement Features parameter of this tool .
void	setInFeatures(java.lang.Object inFeatures) Sets the Input 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

PropagateDisplacement

public PropagateDisplacement()

Creates the Propagate Displacement tool with defaults.

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

PropagateDisplacement

public PropagateDisplacement(java.lang.Object inFeatures,
                             java.lang.Object displacementFeatures,
                             java.lang.String adjustmentStyle)

Creates the Propagate Displacement 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 feature layer containing features that may be in conflict. May be point, line, or polygon.

displacementFeatures - the displacement polygon features created by the Resolve Road Conflicts or the Merge Divided Roads tools which contain the degree and direction of displacement that took place to resolve conflicts. These polygons dictate the amount of displacement that will be propagated to the Input Features.

adjustmentStyle - defines the type of adjustment that will be used when displacing input features.

Method Detail

getInFeatures

public java.lang.Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature layer containing features that may be in conflict. May be point, line, or polygon. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(java.lang.Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input feature layer containing features that may be in conflict. May be point, line, or polygon. This is a required parameter.

Parameters:

inFeatures - the input feature layer containing features that may be in conflict. May be point, line, or polygon.

getDisplacementFeatures

public java.lang.Object getDisplacementFeatures()

Returns the Displacement Features parameter of this tool . This parameter is the displacement polygon features created by the Resolve Road Conflicts or the Merge Divided Roads tools which contain the degree and direction of displacement that took place to resolve conflicts. These polygons dictate the amount of displacement that will be propagated to the Input Features. This is a required parameter.

Returns:

the Displacement Features

setDisplacementFeatures

public void setDisplacementFeatures(java.lang.Object displacementFeatures)

Sets the Displacement Features parameter of this tool . This parameter is the displacement polygon features created by the Resolve Road Conflicts or the Merge Divided Roads tools which contain the degree and direction of displacement that took place to resolve conflicts. These polygons dictate the amount of displacement that will be propagated to the Input Features. This is a required parameter.

Parameters:

displacementFeatures - the displacement polygon features created by the Resolve Road Conflicts or the Merge Divided Roads tools which contain the degree and direction of displacement that took place to resolve conflicts. These polygons dictate the amount of displacement that will be propagated to the Input Features.

getAdjustmentStyle

public java.lang.String getAdjustmentStyle()

Returns the Adjustment Style parameter of this tool . This parameter is defines the type of adjustment that will be used when displacing input features. This is a required parameter.

Returns:

the Adjustment Style

setAdjustmentStyle

public void setAdjustmentStyle(java.lang.String adjustmentStyle)

Sets the Adjustment Style parameter of this tool . This parameter is defines the type of adjustment that will be used when displacing input features. This is a required parameter.

Parameters:

adjustmentStyle - defines the type of adjustment that will be used when displacing input features.

getOutFeatures

public java.lang.Object getOutFeatures()

Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Features

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias