com.esri.arcgis.location
Interface IRouteLocatorOperations2

All Superinterfaces:

IRouteLocatorOperations, Serializable

All Known Implementing Classes:

RouteLocatorOperations

public interface IRouteLocatorOperations2
extends IRouteLocatorOperations, Serializable

Provides access to operations on the route locator.

Description

The IRouteLocatorOperations2 interface provides methods and properties to create an event table, ITable, in several ways:

• A new event table can be created by transforming events from one route reference (route feature class) to another by using the methods LocateLineFeatures and LocatePointEvents.
• A new point event table can be created by locating points along routes by using the method LocatePointFeatures.
• A new line event table can be created by locating lines along routes by using the method LocateLineFeatures.
• A new line event table can be created by locating polygons along routes by using the method LocatePolygonFeatures.

Product Availability

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

Method Summary

IFeatureClass	getRouteFeatureClass() The route feature class (Polyline with M feature class).
ISelectionSet	getRouteFeatureSelection() A selection set of route features.
String	getRouteIDFieldName() The route feature identifier.
void	setRouteFeatureClassByRef(IFeatureClass routeFeatureClass) The route feature class (Polyline with M feature class).
void	setRouteFeatureSelectionByRef(ISelectionSet selection) A selection set of route features.
void	setRouteIDFieldName(String routeIDFieldName) The route feature identifier.

Methods inherited from interface com.esri.arcgis.location.IRouteLocatorOperations

getInputFeatureClass, getInputFeatureSelection, getRouteLocator, locateLineFeatures, locatePointEvents, locatePointFeatures, locatePolygonFeatures, setInputFeatureClassByRef, setInputFeatureSelectionByRef, setRouteLocatorByRef

Method Detail

setRouteFeatureClassByRef

void setRouteFeatureClassByRef(IFeatureClass routeFeatureClass)
                               throws IOException,
                                      AutomationException

The route feature class (Polyline with M feature class).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteFeatureClass

IFeatureClass getRouteFeatureClass()
                                   throws IOException,
                                          AutomationException

The route feature class (Polyline with M feature class).

Remarks

Use this property instead of IRouteLocatorOperations::RouteLocator. When using this property, you must also specify the RouteIDFieldName.

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.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteFeatureSelectionByRef

void setRouteFeatureSelectionByRef(ISelectionSet selection)
                                   throws IOException,
                                          AutomationException

A selection set of route features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getRouteFeatureSelection

ISelectionSet getRouteFeatureSelection()
                                       throws IOException,
                                              AutomationException

A selection set of route features.

Remarks

If you use this method, there is no need to specify the RouteFeatureClass (as it is implied). You still must set the RouteIDFieldName, however.

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.

setRouteIDFieldName

void setRouteIDFieldName(String routeIDFieldName)
                         throws IOException,
                                AutomationException

The route feature identifier.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeIDFieldName - The routeIDFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route feature identifier.

Remarks

Use this property with the RouteFeatureClass (or RouteFeatureSelection) properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.