Display Name: Locate Features Along Routes

Description: 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.

Category:

Help URL: http://agwa.ahu.de/arcgis/rest/directories/arcgisoutput/FISWA/LocateFeaturesAlongRoutes_GPServer/FISWA_LocateFeaturesAlongRoutes/LocateFeaturesAlongRoutes.htm

Execution Type: esriExecutionTypeSynchronous

Parameters:

Parameter: in_features

Data Type: GPFeatureRecordSetLayer
Display Name Input Features
Description: The input point, line, or polygon features.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 25832  (25832)

Fields:
• FID ( type: esriFieldTypeOID, alias: FID )
• canbeempty ( type: esriFieldTypeSmallInteger, alias: canbeempty )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: in_routes

Data Type: GPString
Display Name Input Route Features
Description: The routes with which the input features will be intersected.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: Gewässer, GEWDLM25_ROUTE
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ Gewässer, GEWDLM25_ROUTE ]

Parameter: route_id_field

Data Type: GPString
Display Name Route Identifier Field
Description: The field containing values that uniquely identify each route. This field can be numeric or character.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: GWZ
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ GWZ ]

Parameter: radius_or_tolerance

Data Type: GPLinearUnit
Display Name Search Radius
Description: If the input features are points, the search radius is a numeric value defining how far around each point a search will be done to find a target route. If the input features are lines, the search tolerance is really a cluster tolerance, which is a numeric value representing the maximum tolerated distance between the input lines and the target routes. If the input features are polygons, this parameter is ignored and no search radius is used.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: 10.0   (esriMeters)
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: out_table

Data Type: GPRecordSet
Display Name Output Event Table
Description: The table to be created.
Direction: esriGPParameterDirectionOutput
Dependency:
Default Value:
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: OBJECTID )
• RID ( type: esriFieldTypeString, alias: RID, length: 16 )
• MEAS ( type: esriFieldTypeDouble, alias: MEAS )
• Distance ( type: esriFieldTypeDouble, alias: Distance )
• INPUTOID ( type: esriFieldTypeInteger, alias: INPUTOID )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: out_event_properties

Data Type: GPString
Display Name Output Event Table Properties
Description: Parameter consisting of the route location fields and the type of events that will be written to the output event table. Route Identifier Field—The field that will contain values that indicate along which route each event is.Event Type—The type of events the output event table will contain (POINT or LINE). POINT—Point events occur at a precise location along a route. Only a single measure field must be specified. LINE—Line events define a portion of a route. Both from- and to-measure fields must be specified. From-Measure Field—A field that will contain measure values. Required when the event type is POINT or LINE. Note when the Event Type is POINT, the label for this parameter becomes Measure Field.To-Measure Field—A field that will contain measure values. Required when the event type is LINE.
Direction: esriGPParameterDirectionOutput
Dependency:
Default Value: RID POINT MEAS
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: route_locations

Data Type: GPBoolean
Display Name Keep only the closest route location
Description: 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. Checked—Only the closest route location will be written to the output event table. This is the default. Unchecked—Every route location (within the search radius) will be written to the output event table.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: distance_field

Data Type: GPBoolean
Display Name Include distance field on output table
Description: 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. Checked—A field containing the point-to-route distance will be added to the output event table. This is the default. Unchecked—A field containing the point-to-route distance will not be added to the output event table.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: zero_length_events

Data Type: GPBoolean
Display Name Keep zero length line events
Description: 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. Checked—Zero length line events will be written to the output event table. This is the default. Unchecked—Zero length line events will not be written to the output event table.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: in_fields

Data Type: GPBoolean
Display Name Include all fields from input
Description: Specifies whether the output event table will contain route location fields plus all the attributes from the input features. Checked—The output event table will contain route location fields plus all the attributes from the input features. This is the default. Unchecked—The output event table will only contain route location fields plus the ObjectID field from the input features.
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: m_direction_offsetting

Data Type: GPBoolean
Display Name Use M Direction Offsetting
Description: Specifies whether the offset distance calculated should be based on the M direction or the digitized direction. Distances are included in the output event table if the distance_field parameter value DISTANCE is specified. Checked—The distance values in the output event table will be calculated based on the routes' M direction. Input features to the left of the M Direction of the route will be assigned a positive offset (+), and features to the right of the M Direction will be assigned a negative offset value (-). This is the default. Unchecked—The distance values in the output event table will be calculated based on the routes' digitized direction. Input features to the left of the digitized direction of the route will be assigned a negative (-) offset, and features to the right of the digitized direction will be assigned a positive offset value (+).
Direction: esriGPParameterDirectionInput
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:

Supported Operations:   Execute Task