DISTANCE values are recalculated if this item already exists in the input coverage. If the DISTANCE item is added, it will be in the same precision as the coverage. Items output by NEAR include:
These items are added to the input coverage PAT. If an item named DISTANCE already exists, the values will be recalculated. If the DISTANCE item is added, it will be in the same precision as the coverage. The values for both items will be zero if no match is found within the search_radius for a particular input coverage point.
The calculated distance from point to arc will be from the point to the nearest location along the arc. The calculated distance from point to node will be between the nearest node locations on the arcs.
The distance and the internal number of the closest feature are saved as new items in the input coverage's feature attribute table.
NEAR skips duplicate node numbers to increase operation time.
The coordinate precision of input coverage is not affected by NEAR.
NEAR is useful for assigning point attributes to nearest arcs, or vice versa. This operation is helpful in assigning address ranges to arcs; associating point attributes to nodes, such as DIME node numbers; or finding the nearest available line in a network (for example, determining which sewer line a property might connect with).
Initializes the array of tool parameters with the default values specified when the tool was created.
Near
public Near(java.lang.Object inCover,
java.lang.Object nearCover,
java.lang.Object outCover)
Creates the Near 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, the coverage containing points from which distances are calculated to each closest arc, point, or node in the .
nearCover - Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the .
outCover - Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the .
Method Detail
getInCover
public java.lang.Object getInCover()
Returns the Input Coverage parameter of this tool .
This parameter is Coverage, the coverage containing points from which distances are calculated to each closest arc, point, or node in the .
This is a required parameter.
Returns:
the Input Coverage
setInCover
public void setInCover(java.lang.Object inCover)
Sets the Input Coverage parameter of this tool .
This parameter is Coverage, the coverage containing points from which distances are calculated to each closest arc, point, or node in the .
This is a required parameter.
Parameters:
inCover - Coverage, the coverage containing points from which distances are calculated to each closest arc, point, or node in the .
getNearCover
public java.lang.Object getNearCover()
Returns the Near Coverage parameter of this tool .
This parameter is Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the .
This is a required parameter.
Returns:
the Near Coverage
setNearCover
public void setNearCover(java.lang.Object nearCover)
Sets the Near Coverage parameter of this tool .
This parameter is Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the .
This is a required parameter.
Parameters:
nearCover - Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the .
getOutCover
public java.lang.Object getOutCover()
Returns the Output Coverage parameter of this tool .
This parameter is Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the .
This is a required parameter.
Returns:
the Output Coverage
setOutCover
public void setOutCover(java.lang.Object outCover)
Sets the Output Coverage parameter of this tool .
This parameter is Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the .
This is a required parameter.
Parameters:
outCover - Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the .
getFeatureType
public java.lang.String getFeatureType()
Returns the Feature Type parameter of this tool .
This parameter is String, the type of feature that will be searched from points to find the nearest feature and calculate the distance between them.
This is an optional parameter.
Returns:
the Feature Type
setFeatureType
public void setFeatureType(java.lang.String featureType)
Sets the Feature Type parameter of this tool .
This parameter is String, the type of feature that will be searched from points to find the nearest feature and calculate the distance between them.
This is an optional parameter.
Parameters:
featureType - String, the type of feature that will be searched from points to find the nearest feature and calculate the distance between them.
LINE—A point-to-arc distance will be determined. New items for distance and the internal number of the closest arc in the will be added to the PAT. This is the default option.
POINT—A point-to-point distance will be determined. New items for distance and the internal number of the closest point in the will be added to the PAT.
NODE—A point-to-node distance will be determined. New items for distance and the internal node number of the closest node in the will be added to the PAT.
getSearchRadius
public double getSearchRadius()
Returns the Search Radius parameter of this tool .
This parameter is Double, the default search radius is the width or height of the near coverage BND divided by 100, whichever is larger. This default search radius is used whenever the search radius argument is set to zero or skipped.
This is an optional parameter.
Returns:
the Search Radius
setSearchRadius
public void setSearchRadius(double searchRadius)
Sets the Search Radius parameter of this tool .
This parameter is Double, the default search radius is the width or height of the near coverage BND divided by 100, whichever is larger. This default search radius is used whenever the search radius argument is set to zero or skipped.
This is an optional parameter.
Parameters:
searchRadius - Double, the default search radius is the width or height of the near coverage BND divided by 100, whichever is larger. This default search radius is used whenever the search radius argument is set to zero or skipped.
getLocation
public java.lang.String getLocation()
Returns the Save location of nearest feature parameter of this tool .
This parameter is String, determines whether the x,y coordinates of the "nearest point" of the closest arc, point, or node are to be saved as well as the cover# and distance. The new items are X-COORD and Y-COORD.
This is an optional parameter.
Returns:
the Save location of nearest feature
setLocation
public void setLocation(java.lang.String location)
Sets the Save location of nearest feature parameter of this tool .
This parameter is String, determines whether the x,y coordinates of the "nearest point" of the closest arc, point, or node are to be saved as well as the cover# and distance. The new items are X-COORD and Y-COORD.
This is an optional parameter.
Parameters:
location - String, determines whether the x,y coordinates of the "nearest point" of the closest arc, point, or node are to be saved as well as the cover# and distance. The new items are X-COORD and Y-COORD.
NO_LOCATION—The x,y coordinates of the nearest point are not saved. This is the default.
LOCATION—The x,y coordinates of the nearest point, as well as the cover# and distance, will be saved.
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.