com.esri.arcgis.geoprocessing.tools.coveragetools
Class Tolerance

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

public class Tolerance
extends AbstractGPTool

Sets a coverage's tolerances. The Tolerance tool is contained in the Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Tolerance()
          Creates the Tolerance tool with defaults.
Tolerance(Object inCover)
          Creates the Tolerance tool with the required parameters.
 
Method Summary
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage parameter of this tool (Read only).
 String getToleranceType()
          Returns the Tolerance Type parameter of this tool .
 double getToleranceValue()
          Returns the Tolerance Value 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 setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setToleranceType(String toleranceType)
          Sets the Tolerance Type parameter of this tool .
 void setToleranceValue(double toleranceValue)
          Sets the Tolerance Value 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

Tolerance

public Tolerance()
Creates the Tolerance tool with defaults.

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


Tolerance

public Tolerance(Object inCover)
Creates the 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:
inCover - the coverage for which tolerances will be set.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the coverage for which tolerances will be set. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is the coverage for which tolerances will be set. This is a required parameter.

Parameters:
inCover - the coverage for which tolerances will be set.

getToleranceType

public String getToleranceType()
Returns the Tolerance Type parameter of this tool . This parameter is the type of tolerance to be set. This is an optional parameter.

Returns:
the Tolerance Type

setToleranceType

public void setToleranceType(String toleranceType)
Sets the Tolerance Type parameter of this tool . This parameter is the type of tolerance to be set. This is an optional parameter.

Parameters:
toleranceType - the type of tolerance to be set.

getToleranceValue

public double getToleranceValue()
Returns the Tolerance Value parameter of this tool . This parameter is the value to be set for the selected option's tolerance. A Tolerance Value of zero will not be accepted for the following options: FUZZY, EDIT, NODESNAP, WEED, GRAIN, and SNAP. This is an optional parameter.

Returns:
the Tolerance Value

setToleranceValue

public void setToleranceValue(double toleranceValue)
Sets the Tolerance Value parameter of this tool . This parameter is the value to be set for the selected option's tolerance. A Tolerance Value of zero will not be accepted for the following options: FUZZY, EDIT, NODESNAP, WEED, GRAIN, and SNAP. This is an optional parameter.

Parameters:
toleranceValue - the value to be set for the selected option's tolerance. A Tolerance Value of zero will not be accepted for the following options: FUZZY, EDIT, NODESNAP, WEED, GRAIN, and SNAP.

getOutCover

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

Returns:
the Output Coverage

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