com.esri.arcgis.location
Interface IRouteLocation

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRouteLocation2

All Known Implementing Classes:

RouteMeasureLineLocation, RouteMeasurePointLocation

public interface IRouteLocation
extends Serializable

Provides access to route location properites.

Superseded By

IRouteLocation2

Remarks

The IRouteLocation interface allows you to set the properties of the route measure location.

Product Availability

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

Method Summary

double	getLateralOffset() The route location's lateral offset (default 0.0).
int	getMeasureUnit() The route location's measure units.
Object	getRouteID() The route identifier (string, integer or double).
void	setLateralOffset(double value) The route location's lateral offset (default 0.0).
void	setMeasureUnit(int units) The route location's measure units.
void	setRouteID(Object rid) The route identifier (string, integer or double).

Method Detail

setRouteID

void setRouteID(Object rid)
                throws IOException,
                       AutomationException

The route identifier (string, integer or double).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rid - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteID

Object getRouteID()
                  throws IOException,
                         AutomationException

The route identifier (string, integer or double).

Remarks

The RouteID property defines the route identifier on which the route measure location exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasureUnit

void setMeasureUnit(int units)
                    throws IOException,
                           AutomationException

The route location's measure units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

int getMeasureUnit()
                   throws IOException,
                          AutomationException

The route location's measure units.

Remarks

The MeasureUnit property is the unit of measurement for the route measure location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLateralOffset

void setLateralOffset(double value)
                      throws IOException,
                             AutomationException

The route location's lateral offset (default 0.0).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLateralOffset

double getLateralOffset()
                        throws IOException,
                               AutomationException

The route location's lateral offset (default 0.0).

Remarks

The LateralOffset property is the lateral offset of the route measure location from the route. Whether this offset is to the left or right of the route depends IRouteLocation2::MDirectionOffsetting property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.