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

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

public class FindConflicts
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Finds where simplified buildings overlap or are too close to each other, based on a specified distance. The Find Conflicts tool is contained in the Coverage Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
FindConflicts()
          Creates the Find Conflicts tool with defaults.
FindConflicts(Object inCover, Object outCover, double conflictDistance)
          Creates the Find Conflicts tool with the required parameters.
 
Method Summary
 double getConflictDistance()
          Returns the Conflict Distance parameter of this tool .
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage 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 setConflictDistance(double conflictDistance)
          Sets the Conflict Distance parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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

FindConflicts

public FindConflicts()
Creates the Find Conflicts tool with defaults.

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


FindConflicts

public FindConflicts(Object inCover,
                     Object outCover,
                     double conflictDistance)
Creates the Find Conflicts 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 - Coverage, tool with the POLY option.
outCover - Coverage, the output coverage containing overlapping region buffers, with a subclass BUF, that show spatial conflicts among buildings. This coverage will only be created when conflicts are found. The name must be different from the name.
conflictDistance - Double, sets the conflict distance in coverage units. Buildings within this distance are considered in spatial conflict. The distance must be greater than 0.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, tool with the POLY option. 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 Coverage, tool with the POLY option. This is a required parameter.

Parameters:
inCover - Coverage, tool with the POLY option.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the output coverage containing overlapping region buffers, with a subclass BUF, that show spatial conflicts among buildings. This coverage will only be created when conflicts are found. The name must be different from the name. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the output coverage containing overlapping region buffers, with a subclass BUF, that show spatial conflicts among buildings. This coverage will only be created when conflicts are found. The name must be different from the name. This is a required parameter.

Parameters:
outCover - Coverage, the output coverage containing overlapping region buffers, with a subclass BUF, that show spatial conflicts among buildings. This coverage will only be created when conflicts are found. The name must be different from the name.

getConflictDistance

public double getConflictDistance()
Returns the Conflict Distance parameter of this tool . This parameter is Double, sets the conflict distance in coverage units. Buildings within this distance are considered in spatial conflict. The distance must be greater than 0. This is a required parameter.

Returns:
the Conflict Distance

setConflictDistance

public void setConflictDistance(double conflictDistance)
Sets the Conflict Distance parameter of this tool . This parameter is Double, sets the conflict distance in coverage units. Buildings within this distance are considered in spatial conflict. The distance must be greater than 0. This is a required parameter.

Parameters:
conflictDistance - Double, sets the conflict distance in coverage units. Buildings within this distance are considered in spatial conflict. The distance must be greater than 0.

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