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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.SetClusterTolerance

All Implemented Interfaces:

GPTool

public class SetClusterTolerance
extends AbstractGPTool

Sets the cluster tolerance of a topology. The Set Cluster Tolerance tool is contained in the Data Management Tools tool box.

Usage tips:

• You cannot alter the cluster tolerance for a topology if the topology has been registered as versioned.
• Changing the cluster tolerance will require the entire topology be validated.
• For more information about cluster tolerance, see

Field Summary

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

vals

Constructor Summary

SetClusterTolerance()
Creates the Set Cluster Tolerance tool with defaults.

SetClusterTolerance(java.lang.Object inTopology, double clusterTolerance)
Creates the Set Cluster Tolerance tool with the required parameters.

Method Summary

double	getClusterTolerance() Returns the Cluster Tolerance parameter of this tool .
java.lang.Object	getInTopology() Returns the Input Topology parameter of this tool .
java.lang.Object	getOutTopology() Returns the Output Topology 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	setClusterTolerance(double clusterTolerance) Sets the Cluster Tolerance parameter of this tool .
void	setInTopology(java.lang.Object inTopology) Sets the Input Topology 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

SetClusterTolerance

public SetClusterTolerance()

Creates the Set Cluster Tolerance tool with defaults.

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

SetClusterTolerance

public SetClusterTolerance(java.lang.Object inTopology,
                           double clusterTolerance)

Creates the Set Cluster 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:

inTopology - the topology for which you want to change the cluster tolerance. This is the full path to the topology, note the topology's name or the topology layer's name when in ArcMap.

clusterTolerance - the value to be set as the cluster tolerance property of the selected topology. If you enter a value of zero, the default or minimum cluster tolerance will be applied to the topology.

Method Detail

getInTopology

public java.lang.Object getInTopology()

Returns the Input Topology parameter of this tool . This parameter is the topology for which you want to change the cluster tolerance. This is the full path to the topology, note the topology's name or the topology layer's name when in ArcMap. This is a required parameter.

Returns:

the Input Topology

setInTopology

public void setInTopology(java.lang.Object inTopology)

Sets the Input Topology parameter of this tool . This parameter is the topology for which you want to change the cluster tolerance. This is the full path to the topology, note the topology's name or the topology layer's name when in ArcMap. This is a required parameter.

Parameters:

inTopology - the topology for which you want to change the cluster tolerance. This is the full path to the topology, note the topology's name or the topology layer's name when in ArcMap.

getClusterTolerance

public double getClusterTolerance()

Returns the Cluster Tolerance parameter of this tool . This parameter is the value to be set as the cluster tolerance property of the selected topology. If you enter a value of zero, the default or minimum cluster tolerance will be applied to the topology. This is a required parameter.

Returns:

the Cluster Tolerance

setClusterTolerance

public void setClusterTolerance(double clusterTolerance)

Sets the Cluster Tolerance parameter of this tool . This parameter is the value to be set as the cluster tolerance property of the selected topology. If you enter a value of zero, the default or minimum cluster tolerance will be applied to the topology. This is a required parameter.

Parameters:

clusterTolerance - the value to be set as the cluster tolerance property of the selected topology. If you enter a value of zero, the default or minimum cluster tolerance will be applied to the topology.

getOutTopology

public java.lang.Object getOutTopology()

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

Returns:

the Output Topology

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