com.esri.arcgis.location
Interface IRouteMeasureCalibrator2

All Superinterfaces:

IRouteMeasureCalibrator, Serializable

All Known Implementing Classes:

RouteMeasureCalibrator

public interface IRouteMeasureCalibrator2
extends IRouteMeasureCalibrator, Serializable

Provides access to route measure calibration methods.

Description

The IRouteMeasureCalibrator2 interface is used to calibrate routes at a feature class level.

Routes can be calibrated by two methods:

• CalibrateRoutesByDistance - calibrates by using new measure values from the input points (InputFeatureClass) and the shortest path distance along the polyline between these points.
• CalibrateRoutesByMs - calibrates by using new measure values from the input points and the existing measure distance between these points.

An updateHow parameter is passed into the methods to specify whether calibration is to be done on the entire route or on portions of the route. Here are some examples of upDateHow:

Interpolate = 1
Extrapolate Before = 2
Extrapolate After = 4

A boolean parameter allRoutes is passed into the methods to specify whether all routes are be be included into the output, even the ones which are not calibrated due to no calibration points on the route.

For disjoint routes, gaps can be ignored or not ignored by setting the boolean parameter ignoreGaps to True or False. For CalibrateRoutesByMs, this property is always True.

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 identifier field name.
void	setRouteFeatureClassByRef(IFeatureClass featureClass) The route feature class (Polyline with M feature class).
void	setRouteFeatureSelectionByRef(ISelectionSet selection) A selection set of route features.
void	setRouteIDFieldName(String fieldName) The route identifier field name.

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

calibrateRoutesByDistance, calibrateRoutesByMs, getInputFeatureClass, getInputFeatureSelection, getInputMeasureFieldName, getInputRouteIDFieldName, getRouteLocator, isBuildOutputIndex, setBuildOutputIndex, setInputFeatureClassByRef, setInputFeatureSelectionByRef, setInputMeasureFieldName, setInputRouteIDFieldName, setRouteLocatorByRef

Method Detail

setRouteFeatureClassByRef

void setRouteFeatureClassByRef(IFeatureClass featureClass)
                               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:

featureClass - 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 IRouteMeasureCalibrator::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 fieldName)
                         throws IOException,
                                AutomationException

The route identifier field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route identifier field name.

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 fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.