com.esri.arcgis.location
Interface IRouteMeasureEventGeoprocessor

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRouteMeasureEventGeoprocessor2

All Known Implementing Classes:

RouteMeasureGeoprocessor

public interface IRouteMeasureEventGeoprocessor
extends Serializable

Provides access to the route measure event geoprocessor properties and methods.

Superseded By

IRouteMeasureEventGeoprocessor2

Remarks

A route measure event geoprocessor provides access to geoprocessing operations on route measure events. These operations include dissolving events, concatenating events and event overlay (e.g. line-on-line and point-on-line)

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

ITable	concatenate(Object concatenateFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword) Concatenate events.
ITable	dissolve(Object dissolveFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword) Dissolve events.
IRouteEventProperties	getInputEventProperties() The input table's route event properties.
ISelectionSet	getInputSelection() The input table's selection set.
ITable	getInputTable() The input table.
IRouteEventProperties	getOverlayEventProperties() The overlay table's route event properties.
ISelectionSet	getOverlaySelection() The overlay table's selection set.
ITable	getOverlayTable() The table to overlay with the input table.
ITable	intersect(IRouteEventProperties outputProperties, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword) Intersect events.
boolean	isBuildOutputIndex() Indicates whether an index is going to be built on the route id field on the output result.
boolean	isKeepZeroLengthLineEvents() Indicates whether zero length events should be included in the overlay result (line on line overlays only).
void	setBuildOutputIndex(boolean status) Indicates whether an index is going to be built on the route id field on the output result.
void	setInputEventPropertiesByRef(IRouteEventProperties inputProperties) The input table's route event properties.
void	setInputSelectionByRef(ISelectionSet selection) The input table's selection set.
void	setInputTableByRef(ITable table) The input table.
void	setKeepZeroLengthLineEvents(boolean status) Indicates whether zero length events should be included in the overlay result (line on line overlays only).
void	setOverlayEventPropertiesByRef(IRouteEventProperties overlayProperties) The overlay table's route event properties.
void	setOverlaySelectionByRef(ISelectionSet selection) The overlay table's selection set.
void	setOverlayTableByRef(ITable table) The table to overlay with the input table.
ITable	union(IRouteEventProperties outputProperties, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword) Union events.

Method Detail

setInputTableByRef

void setInputTableByRef(ITable table)
                        throws IOException,
                               AutomationException

The input table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputTable

ITable getInputTable()
                     throws IOException,
                            AutomationException

The input table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputSelectionByRef

void setInputSelectionByRef(ISelectionSet selection)
                            throws IOException,
                                   AutomationException

The input table's selection set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputSelection

ISelectionSet getInputSelection()
                                throws IOException,
                                       AutomationException

The input table's selection set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverlayTableByRef

void setOverlayTableByRef(ITable table)
                          throws IOException,
                                 AutomationException

The table to overlay with the input table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverlayTable

ITable getOverlayTable()
                       throws IOException,
                              AutomationException

The table to overlay with the input table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverlaySelectionByRef

void setOverlaySelectionByRef(ISelectionSet selection)
                              throws IOException,
                                     AutomationException

The overlay table's selection set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverlaySelection

ISelectionSet getOverlaySelection()
                                  throws IOException,
                                         AutomationException

The overlay table's selection set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputEventPropertiesByRef

void setInputEventPropertiesByRef(IRouteEventProperties inputProperties)
                                  throws IOException,
                                         AutomationException

The input table's route event properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

inputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputEventProperties

IRouteEventProperties getInputEventProperties()
                                              throws IOException,
                                                     AutomationException

The input table's route event properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverlayEventPropertiesByRef

void setOverlayEventPropertiesByRef(IRouteEventProperties overlayProperties)
                                    throws IOException,
                                           AutomationException

The overlay table's route event properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

overlayProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverlayEventProperties

IRouteEventProperties getOverlayEventProperties()
                                                throws IOException,
                                                       AutomationException

The overlay table's route event properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepZeroLengthLineEvents

void setKeepZeroLengthLineEvents(boolean status)
                                 throws IOException,
                                        AutomationException

Indicates whether zero length events should be included in the overlay result (line on line overlays only).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepZeroLengthLineEvents

boolean isKeepZeroLengthLineEvents()
                                   throws IOException,
                                          AutomationException

Indicates whether zero length events should be included in the overlay result (line on line overlays only).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildOutputIndex

void setBuildOutputIndex(boolean status)
                         throws IOException,
                                AutomationException

Indicates whether an index is going to be built on the route id field on the output result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildOutputIndex

boolean isBuildOutputIndex()
                           throws IOException,
                                  AutomationException

Indicates whether an index is going to be built on the route id field on the output result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dissolve

ITable dissolve(Object dissolveFields,
                IDatasetName outputName,
                ITrackCancel trackCancel,
                String configKeyword)
                throws IOException,
                       AutomationException

Dissolve events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

dissolveFields - A Variant (in)

outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

configKeyword - The configKeyword (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

concatenate

ITable concatenate(Object concatenateFields,
                   IDatasetName outputName,
                   ITrackCancel trackCancel,
                   String configKeyword)
                   throws IOException,
                          AutomationException

Concatenate events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

concatenateFields - A Variant (in)

outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

configKeyword - The configKeyword (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersect

ITable intersect(IRouteEventProperties outputProperties,
                 IDatasetName outputName,
                 ITrackCancel trackCancel,
                 String configKeyword)
                 throws IOException,
                        AutomationException

Intersect events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)

outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

configKeyword - The configKeyword (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

union

ITable union(IRouteEventProperties outputProperties,
             IDatasetName outputName,
             ITrackCancel trackCancel,
             String configKeyword)
             throws IOException,
                    AutomationException

Union events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)

outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

configKeyword - The configKeyword (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.