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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.linearreferencingtools.TransformRouteEvents

All Implemented Interfaces:

GPTool

public class TransformRouteEvents
extends AbstractGPTool

Transforms the measures of events from one route reference to another and writes them to a new event table. The Transform Route Events tool is contained in the Linear Referencing Tools tool box.

Software restrictions: none

Usage tips:

• Transforming events allows you to use the events from one route reference with another route reference having different route identifiers and/or measures.
• Any whole or partial event that intersects a target route is written to the new event table.
• The output event type (POINT or LINE) must match the input event type.
• The best results will be achieved when the source routes and the target routes closely overlay. Do not use a large cluster tolerance to try and overcome discrepancies between the source and target routes because it can lead to unexpected results.
• Use Make Table View; prior to Transform Route Events to effectively reduce the number of events that will be processed.
• The output table can be displayed in ArcMap using Make Route Event Layer; or the Add Route Events; dialog box.
• Learn more about transforming event measures;
• The following environments affect this tool: configKeyword; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

TransformRouteEvents()
Creates the Transform Route Events tool with defaults.

TransformRouteEvents(Object inTable, Object inEventProperties, Object inRoutes, Object routeIdField, Object targetRoutes, Object targetRouteIdField, Object outTable, Object outEventProperties, Object clusterTolerance)
Creates the Transform Route Events tool with the required parameters.

Method Summary

Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
Object	getInEventProperties() Returns the Event Table Properties parameter of this tool .
String	getInFields() Returns the Include all fields from input parameter of this tool .
Object	getInRoutes() Returns the Source Route Features parameter of this tool .
Object	getInTable() Returns the Input Event Table 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	getRouteIdField() Returns the Source Route Identifier Field parameter of this tool .
Object	getTargetRouteIdField() Returns the Target Route Identifier Field parameter of this tool .
Object	getTargetRoutes() Returns the Target Route Features 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	setClusterTolerance(Object clusterTolerance) Sets the XY Tolerance parameter of this tool .
void	setInEventProperties(Object inEventProperties) Sets the Event Table Properties 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 Source Route Features parameter of this tool .
void	setInTable(Object inTable) Sets the Input Event Table 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	setRouteIdField(Object routeIdField) Sets the Source Route Identifier Field parameter of this tool .
void	setTargetRouteIdField(Object targetRouteIdField) Sets the Target Route Identifier Field parameter of this tool .
void	setTargetRoutes(Object targetRoutes) Sets the Target Route Features 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

TransformRouteEvents

public TransformRouteEvents()

Creates the Transform Route Events tool with defaults.

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

TransformRouteEvents

public TransformRouteEvents(Object inTable,
                            Object inEventProperties,
                            Object inRoutes,
                            Object routeIdField,
                            Object targetRoutes,
                            Object targetRouteIdField,
                            Object outTable,
                            Object outEventProperties,
                            Object clusterTolerance)

Creates the Transform Route Events 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:

inTable - Table View, the input event table.

inEventProperties - Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric, and it is required when the event type is LINE.

inRoutes - Feature Layer, the input route features.

routeIdField - Field, the field containing values that uniquely identifies each input route.

targetRoutes - Feature Layer, the route features to which the input events will be transformed.

targetRouteIdField - Field, the field containing values that uniquely identifies each target route.

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.

clusterTolerance - Linear unit, the maximum tolerated distance between the input events and the target routes.

Method Detail

getInTable

public Object getInTable()

Returns the Input Event Table parameter of this tool . This parameter is Table View, the input event table. This is a required parameter.

Returns:

the Input Event Table

setInTable

public void setInTable(Object inTable)

Sets the Input Event Table parameter of this tool . This parameter is Table View, the input event table. This is a required parameter.

Parameters:

inTable - Table View, the input event table.

getInEventProperties

public Object getInEventProperties()

Returns the Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric, and it is required when the event type is LINE. This is a required parameter.

Returns:

the Event Table Properties

setInEventProperties

public void setInEventProperties(Object inEventProperties)

Sets the Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric, and it is required when the event type is LINE. This is a required parameter.

Parameters:

inEventProperties - Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric, and it is required when the event type is LINE.

getInRoutes

public Object getInRoutes()

Returns the Source Route Features parameter of this tool . This parameter is Feature Layer, the input route features. This is a required parameter.

Returns:

the Source Route Features

setInRoutes

public void setInRoutes(Object inRoutes)

Sets the Source Route Features parameter of this tool . This parameter is Feature Layer, the input route features. This is a required parameter.

Parameters:

inRoutes - Feature Layer, the input route features.

getRouteIdField

public Object getRouteIdField()

Returns the Source Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identifies each input route. This is a required parameter.

Returns:

the Source Route Identifier Field

setRouteIdField

public void setRouteIdField(Object routeIdField)

Sets the Source Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identifies each input route. This is a required parameter.

Parameters:

routeIdField - Field, the field containing values that uniquely identifies each input route.

getTargetRoutes

public Object getTargetRoutes()

Returns the Target Route Features parameter of this tool . This parameter is Feature Layer, the route features to which the input events will be transformed. This is a required parameter.

Returns:

the Target Route Features

setTargetRoutes

public void setTargetRoutes(Object targetRoutes)

Sets the Target Route Features parameter of this tool . This parameter is Feature Layer, the route features to which the input events will be transformed. This is a required parameter.

Parameters:

targetRoutes - Feature Layer, the route features to which the input events will be transformed.

getTargetRouteIdField

public Object getTargetRouteIdField()

Returns the Target Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identifies each target route. This is a required parameter.

Returns:

the Target Route Identifier Field

setTargetRouteIdField

public void setTargetRouteIdField(Object targetRouteIdField)

Sets the Target Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identifies each target route. This is a required parameter.

Parameters:

targetRouteIdField - Field, the field containing values that uniquely identifies each target route.

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.

getClusterTolerance

public Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is Linear unit, the maximum tolerated distance between the input events and the target routes. This is a required parameter.

Returns:

the XY Tolerance

setClusterTolerance

public void setClusterTolerance(Object clusterTolerance)

Sets the XY Tolerance parameter of this tool . This parameter is Linear unit, the maximum tolerated distance between the input events and the target routes. This is a required parameter.

Parameters:

clusterTolerance - Linear unit, the maximum tolerated distance between the input events and the target 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 events. 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 events. 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 events.

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