com.esri.arcgis.geoprocessing.tools.linearreferencingtools
Class LocateFeaturesAlongRoutes

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

public class LocateFeaturesAlongRoutes
extends AbstractGPTool

Computes the intersection of input features (point, line, or polygon) and route features and writes the route and measure information to a new event table. The Locate Features Along Routes tool is contained in the Linear Referencing Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
LocateFeaturesAlongRoutes()
          Creates the Locate Features Along Routes tool with defaults.
LocateFeaturesAlongRoutes(Object inFeatures, Object inRoutes, Object routeIdField, Object radiusOrTolerance, Object outTable, Object outEventProperties)
          Creates the Locate Features Along Routes tool with the required parameters.
 
Method Summary
 String getDistanceField()
          Returns the Include distance field on output table parameter of this tool .
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 String getInFields()
          Returns the Include all fields from input parameter of this tool .
 Object getInRoutes()
          Returns the Input Route Features parameter of this tool .
 Object getOutEventProperties()
          Returns the Output Event Table Properties parameter of this tool .
 Object getOutTable()
          Returns the Output Event Table parameter of this tool .
 Object getRadiusOrTolerance()
          Returns the Search Radius parameter of this tool .
 Object getRouteIdField()
          Returns the Route Identifier Field parameter of this tool .
 String getRouteLocations()
          Returns the Keep only the closest route location 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.
 String getZeroLengthEvents()
          Returns the Keep zero length line events parameter of this tool .
 void setDistanceField(String distanceField)
          Sets the Include distance field on output table parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setInFields(String inFields)
          Sets the Include all fields from input parameter of this tool .
 void setInRoutes(Object inRoutes)
          Sets the Input Route Features parameter of this tool .
 void setOutEventProperties(Object outEventProperties)
          Sets the Output Event Table Properties parameter of this tool .
 void setOutTable(Object outTable)
          Sets the Output Event Table parameter of this tool .
 void setRadiusOrTolerance(Object radiusOrTolerance)
          Sets the Search Radius parameter of this tool .
 void setRouteIdField(Object routeIdField)
          Sets the Route Identifier Field parameter of this tool .
 void setRouteLocations(String routeLocations)
          Sets the Keep only the closest route location parameter of this tool .
 void setZeroLengthEvents(String zeroLengthEvents)
          Sets the Keep zero length line events 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

LocateFeaturesAlongRoutes

public LocateFeaturesAlongRoutes()
Creates the Locate Features Along Routes tool with defaults.

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


LocateFeaturesAlongRoutes

public LocateFeaturesAlongRoutes(Object inFeatures,
                                 Object inRoutes,
                                 Object routeIdField,
                                 Object radiusOrTolerance,
                                 Object outTable,
                                 Object outEventProperties)
Creates the Locate Features Along Routes 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 input point, line, or polygon features.
inRoutes - Feature Layer, the routes with which the input features will be intersected.
routeIdField - Field, the field containing values that uniquely identify each route. This field can be numeric or character.
radiusOrTolerance - Linear unit, if the input features are polygons, this parameter is ignored since no search radius is used.
outTable - Table, the table to be created.
outEventProperties - Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the input point, line, or polygon features. 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 input point, line, or polygon features. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the input point, line, or polygon features.

getInRoutes

public Object getInRoutes()
Returns the Input Route Features parameter of this tool . This parameter is Feature Layer, the routes with which the input features will be intersected. This is a required parameter.

Returns:
the Input Route Features

setInRoutes

public void setInRoutes(Object inRoutes)
Sets the Input Route Features parameter of this tool . This parameter is Feature Layer, the routes with which the input features will be intersected. This is a required parameter.

Parameters:
inRoutes - Feature Layer, the routes with which the input features will be intersected.

getRouteIdField

public Object getRouteIdField()
Returns the Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identify each route. This field can be numeric or character. This is a required parameter.

Returns:
the Route Identifier Field

setRouteIdField

public void setRouteIdField(Object routeIdField)
Sets the Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identify each route. This field can be numeric or character. This is a required parameter.

Parameters:
routeIdField - Field, the field containing values that uniquely identify each route. This field can be numeric or character.

getRadiusOrTolerance

public Object getRadiusOrTolerance()
Returns the Search Radius parameter of this tool . This parameter is Linear unit, if the input features are polygons, this parameter is ignored since no search radius is used. This is a required parameter.

Returns:
the Search Radius

setRadiusOrTolerance

public void setRadiusOrTolerance(Object radiusOrTolerance)
Sets the Search Radius parameter of this tool . This parameter is Linear unit, if the input features are polygons, this parameter is ignored since no search radius is used. This is a required parameter.

Parameters:
radiusOrTolerance - Linear unit, if the input features are polygons, this parameter is ignored since no search radius is used.

getOutTable

public Object getOutTable()
Returns the Output Event Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Returns:
the Output Event Table

setOutTable

public void setOutTable(Object outTable)
Sets the Output Event Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Parameters:
outTable - Table, the table to be created.

getOutEventProperties

public Object getOutEventProperties()
Returns the Output Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE. This is a required parameter.

Returns:
the Output Event Table Properties

setOutEventProperties

public void setOutEventProperties(Object outEventProperties)
Sets the Output Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE. This is a required parameter.

Parameters:
outEventProperties - Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE.

getRouteLocations

public String getRouteLocations()
Returns the Keep only the closest route location parameter of this tool . This parameter is String, when locating points along routes, it is possible that more than one route may be within the search radius of any given point. This parameter is ignored when locating lines or polygons along routes. This is an optional parameter.

Returns:
the Keep only the closest route location

setRouteLocations

public void setRouteLocations(String routeLocations)
Sets the Keep only the closest route location parameter of this tool . This parameter is String, when locating points along routes, it is possible that more than one route may be within the search radius of any given point. This parameter is ignored when locating lines or polygons along routes. This is an optional parameter.

Parameters:
routeLocations - String, when locating points along routes, it is possible that more than one route may be within the search radius of any given point. This parameter is ignored when locating lines or polygons along routes.

getDistanceField

public String getDistanceField()
Returns the Include distance field on output table parameter of this tool . This parameter is String, specifies whether a field named DISTANCE will be added to the output event table. The values in this field are in the units of the specified search radius. This parameter is ignored when locating lines or polygons along routes. This is an optional parameter.

Returns:
the Include distance field on output table

setDistanceField

public void setDistanceField(String distanceField)
Sets the Include distance field on output table parameter of this tool . This parameter is String, specifies whether a field named DISTANCE will be added to the output event table. The values in this field are in the units of the specified search radius. This parameter is ignored when locating lines or polygons along routes. This is an optional parameter.

Parameters:
distanceField - String, specifies whether a field named DISTANCE will be added to the output event table. The values in this field are in the units of the specified search radius. This parameter is ignored when locating lines or polygons along routes.

getZeroLengthEvents

public String getZeroLengthEvents()
Returns the Keep zero length line events parameter of this tool . This parameter is String, when locating polygons along routes, it is possible that events can be created where the from-measure is equal to the to-measure. This parameter is ignored when locating points or lines along routes. This is an optional parameter.

Returns:
the Keep zero length line events

setZeroLengthEvents

public void setZeroLengthEvents(String zeroLengthEvents)
Sets the Keep zero length line events parameter of this tool . This parameter is String, when locating polygons along routes, it is possible that events can be created where the from-measure is equal to the to-measure. This parameter is ignored when locating points or lines along routes. This is an optional parameter.

Parameters:
zeroLengthEvents - String, when locating polygons along routes, it is possible that events can be created where the from-measure is equal to the to-measure. This parameter is ignored when locating points or lines along routes.

getInFields

public String getInFields()
Returns the Include all fields from input parameter of this tool . This parameter is String, specifies whether the output event table will contain route location fields plus all the attributes from the input features. This is an optional parameter.

Returns:
the Include all fields from input

setInFields

public void setInFields(String inFields)
Sets the Include all fields from input parameter of this tool . This parameter is String, specifies whether the output event table will contain route location fields plus all the attributes from the input features. This is an optional parameter.

Parameters:
inFields - String, specifies whether the output event table will contain route location fields plus all the attributes from 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