com.esri.arcgis.geoprocessing.tools.analysistools
Class PointDistance

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.PointDistance

All Implemented Interfaces:

GPTool

public class PointDistance
extends AbstractGPTool

Determines the distances from input point features to all points in the near features within a specified search radius. The Point Distance tool is contained in the Analysis Tools tool box.

Usage tips:

• The tool creates a distance matrix between two sets of points if the default search radius is used in which case distances from all input features to all near features are calculated. The output table can be quite large. For example, if both input and near features have 1000 points each then the output table can contain one million records. Use a meaningful search radius to limit the size of the output.
• The results are recorded in the output table containing the following information:
• Both the Input Features and Near Features can be the same dataset. In that case when the input and near features are the same record, that result will be skipped so as not to report that each feature is 0 units from itself.

Field Summary

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

vals

Constructor Summary

PointDistance()
Creates the Point Distance tool with defaults.

PointDistance(Object inFeatures, Object nearFeatures, Object outTable)
Creates the Point Distance tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getNearFeatures() Returns the Near Features parameter of this tool .
Object	getOutTable() Returns the Output Table parameter of this tool .
Object	getSearchRadius() Returns the Search Radius 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 .
void	setNearFeatures(Object nearFeatures) Sets the Near Features parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table parameter of this tool .
void	setSearchRadius(Object searchRadius) Sets the Search Radius 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

PointDistance

public PointDistance()

Creates the Point Distance tool with defaults.

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

PointDistance

public PointDistance(Object inFeatures,
                     Object nearFeatures,
                     Object outTable)

Creates the Point Distance 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 point features from which distances to the near features will be calculated.

nearFeatures - the points to which distances from the input features will be calculated. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the input and near features.

outTable - the table containing the list of input features and information of about all near features within the search radius. If a search radius is not specified distances from all input features to all near features are calculated.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the point features from which distances to the near features 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 point features from which distances to the near features will be calculated. This is a required parameter.

Parameters:

inFeatures - the point features from which distances to the near features will be calculated.

getNearFeatures

public Object getNearFeatures()

Returns the Near Features parameter of this tool . This parameter is the points to which distances from the input features will be calculated. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the input and near features. This is a required parameter.

Returns:

the Near Features

setNearFeatures

public void setNearFeatures(Object nearFeatures)

Sets the Near Features parameter of this tool . This parameter is the points to which distances from the input features will be calculated. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the input and near features. This is a required parameter.

Parameters:

nearFeatures - the points to which distances from the input features will be calculated. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the input and near features.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the table containing the list of input features and information of about all near features within the search radius. If a search radius is not specified distances from all input features to all near features are calculated. This is a required parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(Object outTable)

Sets the Output Table parameter of this tool . This parameter is the table containing the list of input features and information of about all near features within the search radius. If a search radius is not specified distances from all input features to all near features are calculated. This is a required parameter.

Parameters:

outTable - the table containing the list of input features and information of about all near features within the search radius. If a search radius is not specified distances from all input features to all near features are calculated.

getSearchRadius

public Object getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is distances will only be calculated for those near features that are within the search radius of the input features. This is an optional parameter.

Returns:

the Search Radius

setSearchRadius

public void setSearchRadius(Object searchRadius)

Sets the Search Radius parameter of this tool . This parameter is distances will only be calculated for those near features that are within the search radius of the input features. This is an optional parameter.

Parameters:

searchRadius - distances will only be calculated for those near features that are within the search radius of the input features.

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