com.esri.arcgis.location
Interface IRouteEventSource

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRouteEventSourceProxy, RouteEventSource

public interface IRouteEventSource
extends Serializable

Provides access to the route event source properties.

Product Availability

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

Method Summary

IRouteEventProperties	getEventProperties() The route event properties.
ITable	getEventTable() The table of containing route events.
double	getExpandDistance() The distance used to expand spatial searches for laterally offset events.
IRouteLocator	getRouteLocator() The route locator.
void	setExpandDistance(double distance) The distance used to expand spatial searches for laterally offset events.

Method Detail

getRouteLocator

IRouteLocator getRouteLocator()
                              throws IOException,
                                     AutomationException

The route locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.location.IRouteLocator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventTable

ITable getEventTable()
                     throws IOException,
                            AutomationException

The table of containing route events.

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.

getEventProperties

IRouteEventProperties getEventProperties()
                                         throws IOException,
                                                AutomationException

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

setExpandDistance

void setExpandDistance(double distance)
                       throws IOException,
                              AutomationException

The distance used to expand spatial searches for laterally offset events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

distance - The distance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpandDistance

double getExpandDistance()
                         throws IOException,
                                AutomationException

The distance used to expand spatial searches for laterally offset events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.