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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• This tool cannot be used to reset the value of default XY Tolerance; it can only calculate the XY tolerance value.
• The result of this tool will be returned as a message from the tool. The values can be viewed in the geoprocessing Results window, or the value can be assigned to a variable in scripting by accessing the tool execution result object.
• Although the default XY tolerance of non-geodatabase feature classes maybe different depending on the spatial reference, its value is equivalent to 0.001 meter. This default value cannot be changed.
• The XY tolerance of a geodatabase feature classes can be specified when a new feature class, or its containing feature dataset or topology, is created in a geodatabase. If you do not specify a new XY tolerance, the default values of the containing feature classes are used, which usually is equivalent to 0.001 meter. If the feature class is saved in a topology of a geodatabase, then XY tolerance can be reset using the tool. For more information, you can right-click any feature class or dataset and click Properties, then select the Tolerance tab, then check About Setting Tolerance help.
• Most tools that create new feature classes (such as Create Feature Class or Copy Features) honor the environment setting. However, only those tools that use this environment will set the XY tolerance on the output feature class. The input XY tolerance will not be affected by this environment setting.

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