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

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

public class DisperseMarkers
extends AbstractGPTool

Finds representation markers that are overlapping or too close to one another and spreads them apart based on a minimum spacing and dispersal pattern. The Disperse Markers tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DisperseMarkers()
          Creates the Disperse Markers tool with defaults.
DisperseMarkers(Object inPointFeatures, Object minimumSpacing)
          Creates the Disperse Markers tool with the required parameters.
 
Method Summary
 String getDispersalPattern()
          Returns the Dispersal Pattern parameter of this tool .
 Object getInPointFeatures()
          Returns the Input Point Features With Marker Representations parameter of this tool .
 Object getMinimumSpacing()
          Returns the Minimum Spacing parameter of this tool .
 Object getOutRepresentations()
          Returns the Output Representations parameter of this tool (Read only).
 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 setDispersalPattern(String dispersalPattern)
          Sets the Dispersal Pattern parameter of this tool .
 void setInPointFeatures(Object inPointFeatures)
          Sets the Input Point Features With Marker Representations parameter of this tool .
 void setMinimumSpacing(Object minimumSpacing)
          Sets the Minimum Spacing 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

DisperseMarkers

public DisperseMarkers()
Creates the Disperse Markers tool with defaults.

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


DisperseMarkers

public DisperseMarkers(Object inPointFeatures,
                       Object minimumSpacing)
Creates the Disperse Markers 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:
inPointFeatures - Feature Layer, the input point feature layer containing marker representations.
minimumSpacing - Linear unit, the minimum separation distance between individual markers in page units. A distance must be specified and must be greater than or equal to zero. When a positive value is specified, markers are separated by that value; when a value of zero is specified, markers are touching. The default page unit is Points.
Method Detail

getInPointFeatures

public Object getInPointFeatures()
Returns the Input Point Features With Marker Representations parameter of this tool . This parameter is Feature Layer, the input point feature layer containing marker representations. This is a required parameter.

Returns:
the Input Point Features With Marker Representations

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)
Sets the Input Point Features With Marker Representations parameter of this tool . This parameter is Feature Layer, the input point feature layer containing marker representations. This is a required parameter.

Parameters:
inPointFeatures - Feature Layer, the input point feature layer containing marker representations.

getMinimumSpacing

public Object getMinimumSpacing()
Returns the Minimum Spacing parameter of this tool . This parameter is Linear unit, the minimum separation distance between individual markers in page units. A distance must be specified and must be greater than or equal to zero. When a positive value is specified, markers are separated by that value; when a value of zero is specified, markers are touching. The default page unit is Points. This is a required parameter.

Returns:
the Minimum Spacing

setMinimumSpacing

public void setMinimumSpacing(Object minimumSpacing)
Sets the Minimum Spacing parameter of this tool . This parameter is Linear unit, the minimum separation distance between individual markers in page units. A distance must be specified and must be greater than or equal to zero. When a positive value is specified, markers are separated by that value; when a value of zero is specified, markers are touching. The default page unit is Points. This is a required parameter.

Parameters:
minimumSpacing - Linear unit, the minimum separation distance between individual markers in page units. A distance must be specified and must be greater than or equal to zero. When a positive value is specified, markers are separated by that value; when a value of zero is specified, markers are touching. The default page unit is Points.

getDispersalPattern

public String getDispersalPattern()
Returns the Dispersal Pattern parameter of this tool . This parameter is String, specifies the pattern in which the dispersed representation markers are placed. A group of markers will have a center of mass derived from the locations of each marker in the group. The center of mass is then used as the anchor point around which the dispersal pattern operates. This is an optional parameter.

Returns:
the Dispersal Pattern

setDispersalPattern

public void setDispersalPattern(String dispersalPattern)
Sets the Dispersal Pattern parameter of this tool . This parameter is String, specifies the pattern in which the dispersed representation markers are placed. A group of markers will have a center of mass derived from the locations of each marker in the group. The center of mass is then used as the anchor point around which the dispersal pattern operates. This is an optional parameter.

Parameters:
dispersalPattern - String, specifies the pattern in which the dispersed representation markers are placed. A group of markers will have a center of mass derived from the locations of each marker in the group. The center of mass is then used as the anchor point around which the dispersal pattern operates.

getOutRepresentations

public Object getOutRepresentations()
Returns the Output Representations parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Representations

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