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

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

public class PointDistance
extends AbstractGPTool

Determines the distances between point features in the Input Features to all points in the Near Features, within the Search Radius. The Point Distance tool is contained in the Analysis Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:


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 - Feature Layer, the point features from which distances to the Near Features will be calculated.
nearFeatures - Feature Layer, the points to which distances from the Input Features will be determined. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the Input Features and Near Features.
outTable - Table, the table contains the list of Input Features and information of about all Near Features within the Search Radius. If Search Radius is not used, the number of records in the output table may be quite large as it will the number of features in the Input Features multiplied by the number of features in the Input Features.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, 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 Feature Layer, the point features from which distances to the Near Features will be calculated. This is a required parameter.

Parameters:
inFeatures - Feature Layer, 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 Feature Layer, the points to which distances from the Input Features will be determined. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the Input Features 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 Feature Layer, the points to which distances from the Input Features will be determined. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the Input Features and Near Features. This is a required parameter.

Parameters:
nearFeatures - Feature Layer, the points to which distances from the Input Features will be determined. Distances between points within the same feature class or layer can be determined by specifying the same feature class or layer for the Input Features and Near Features.

getOutTable

public Object getOutTable()
Returns the Output Table parameter of this tool . This parameter is Table, the table contains the list of Input Features and information of about all Near Features within the Search Radius. If Search Radius is not used, the number of records in the output table may be quite large as it will the number of features in the Input Features multiplied by the number of features in the Input Features. 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 Table, the table contains the list of Input Features and information of about all Near Features within the Search Radius. If Search Radius is not used, the number of records in the output table may be quite large as it will the number of features in the Input Features multiplied by the number of features in the Input Features. This is a required parameter.

Parameters:
outTable - Table, the table contains the list of Input Features and information of about all Near Features within the Search Radius. If Search Radius is not used, the number of records in the output table may be quite large as it will the number of features in the Input Features multiplied by the number of features in the Input Features.

getSearchRadius

public Object getSearchRadius()
Returns the Search Radius parameter of this tool . This parameter is Linear unit, 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 Linear unit, 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 - Linear unit, 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