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

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

public class CalculateDefaultClusterTolerance
extends AbstractGPTool

Calculates a default XY tolerance by examining the spatial reference and the extent of the feature class. The Calculate Default XY Tolerance tool is contained in the Data Management Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculateDefaultClusterTolerance()
          Creates the Calculate Default XY Tolerance tool with defaults.
CalculateDefaultClusterTolerance(Object inFeatures)
          Creates the Calculate Default XY Tolerance tool with the required parameters.
 
Method Summary
 double getClusterTolerance()
          Returns the Default XY Tolerance parameter of this tool (Read only).
 Object getInFeatures()
          Returns the Input 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 .
 
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

CalculateDefaultClusterTolerance

public CalculateDefaultClusterTolerance()
Creates the Calculate Default XY Tolerance tool with defaults.

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


CalculateDefaultClusterTolerance

public CalculateDefaultClusterTolerance(Object inFeatures)
Creates the Calculate Default XY Tolerance 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 feature class for which the default XY tolerance will be calculated.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is the feature class for which the default XY tolerance will be calculated. 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 feature class for which the default XY tolerance will be calculated. This is a required parameter.

Parameters:
inFeatures - the feature class for which the default XY tolerance will be calculated.

getClusterTolerance

public double getClusterTolerance()
Returns the Default XY Tolerance parameter of this tool (Read only). This is an derived parameter.

Returns:
the Default XY Tolerance

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