com.esri.arcgis.location
Interface IRouteMeasureCalibrator

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRouteMeasureCalibrator2

All Known Implementing Classes:

RouteMeasureCalibrator

public interface IRouteMeasureCalibrator
extends Serializable

Provides access to route measure calibration methods.

Superseded By

IRouteMeasureCalibrator2

Description

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

See IRouteMeasureCalibrator2.

Remarks

The results of CalibrateRoutesByDistance and CalibrateRoutesByMs is an IEnumBSTR, which is a container for the list of errors encountered during route calibration.

Product Availability

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

Method Summary

IEnumBSTR	calibrateRoutesByDistance(int updateHow, boolean ignoreGaps, double tolerance, boolean allRoutes, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Calibrate route features.
IEnumBSTR	calibrateRoutesByMs(int updateHow, double tolerance, boolean allRoutes, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Calibrate route features by using existing M values for the interpolation.
IFeatureClass	getInputFeatureClass() The input features to locate along the routes.
ISelectionSet	getInputFeatureSelection() A selection set of features to locate.
String	getInputMeasureFieldName() The input measure field name.
String	getInputRouteIDFieldName() The input route identifier field name.
IRouteLocator	getRouteLocator() The route locator.
boolean	isBuildOutputIndex() Indicates whether an index is going to be built on the route id field on the output result.
void	setBuildOutputIndex(boolean status) Indicates whether an index is going to be built on the route id field on the output result.
void	setInputFeatureClassByRef(IFeatureClass inputFeatureClass) The input features to locate along the routes.
void	setInputFeatureSelectionByRef(ISelectionSet selection) A selection set of features to locate.
void	setInputMeasureFieldName(String fieldName) The input measure field name.
void	setInputRouteIDFieldName(String fieldName) The input route identifier field name.
void	setRouteLocatorByRef(IRouteLocator routeLocator) The route locator.

Method Detail

setRouteLocatorByRef

void setRouteLocatorByRef(IRouteLocator routeLocator)
                          throws IOException,
                                 AutomationException

The route locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeLocator - A reference to a com.esri.arcgis.location.IRouteLocator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteLocator

IRouteLocator getRouteLocator()
                              throws IOException,
                                     AutomationException

The route locator.

Description

Use the IRouteMeasureCalibrator2::RouteFeatureClass (or RouteFeatureSelection) and IRouteMeasureCalibrator2::RouteIDFieldName properties instead.

Remarks

The RouteLocator property sets the route locator which contains information about the route feature class, such as the route identifier, spatial reference, etc.

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.

setInputFeatureClassByRef

void setInputFeatureClassByRef(IFeatureClass inputFeatureClass)
                               throws IOException,
                                      AutomationException

The input features to locate along the routes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getInputFeatureClass

IFeatureClass getInputFeatureClass()
                                   throws IOException,
                                          AutomationException

The input features to locate along the routes.

Remarks

The InputFeatureClass is used to set the feature class, IFeatureClass, which contains the calibration points. The geometry type of the InputFeatureClass must of type Point or Multipoint.

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.

setInputFeatureSelectionByRef

void setInputFeatureSelectionByRef(ISelectionSet selection)
                                   throws IOException,
                                          AutomationException

A selection set of features to locate.

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.

getInputFeatureSelection

ISelectionSet getInputFeatureSelection()
                                       throws IOException,
                                              AutomationException

A selection set of features to locate.

Description

The InputFeatureSelection is used to specify a selection set, ISelectionSet, for the calibration points. If this property and the InputFeatureClass property is set, the InputFeatureSelection is used.

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.

setInputRouteIDFieldName

void setInputRouteIDFieldName(String fieldName)
                              throws IOException,
                                     AutomationException

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

getInputRouteIDFieldName

String getInputRouteIDFieldName()
                                throws IOException,
                                       AutomationException

The input route identifier field name.

Remarks

The InputRouteIDFieldName property sets the route identifier for the point feature class, specifying which route each calibration point refers to.

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.

setInputMeasureFieldName

void setInputMeasureFieldName(String fieldName)
                              throws IOException,
                                     AutomationException

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

getInputMeasureFieldName

String getInputMeasureFieldName()
                                throws IOException,
                                       AutomationException

The input measure field name.

Remarks

The InputMeasureFieldName property sets the field in the point feature class which is used to set the measure value of the route at the point.

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.

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.

Remarks

The BuildOutputIndex property can be used to create an index on the route identifier of the output feature class.

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.

calibrateRoutesByDistance

IEnumBSTR calibrateRoutesByDistance(int updateHow,
                                    boolean ignoreGaps,
                                    double tolerance,
                                    boolean allRoutes,
                                    IFeatureClassName outputFClassName,
                                    IGeometryDef outputGeometryDef,
                                    String configKeyword,
                                    ITrackCancel trackCancel)
                                    throws IOException,
                                           AutomationException

Calibrate route features.

Remarks

The outputFClassName parameter in this method is the IFeatureClassName, from which the properties of the output feature class can be set.

The outputGeometryDef parameter sets the IGeometryDef for the output feature class. The geometry definition of the output feature class must have HasMs = True, and should have an adequate M extent (MDomain) so the new measures can be set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

updateHow - The updateHow (in)

ignoreGaps - The ignoreGaps (in)

tolerance - The tolerance (in)

allRoutes - The allRoutes (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

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

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calibrateRoutesByMs

IEnumBSTR calibrateRoutesByMs(int updateHow,
                              double tolerance,
                              boolean allRoutes,
                              IFeatureClassName outputFClassName,
                              IGeometryDef outputGeometryDef,
                              String configKeyword,
                              ITrackCancel trackCancel)
                              throws IOException,
                                     AutomationException

Calibrate route features by using existing M values for the interpolation.

Remarks

The outputFClassName parameter in this method is the IFeatureClassName , from which the properties of the output feature class can be set.

The outputGeometryDef parameter sets the IGeometryDef for the output feature class. The geometry definition of the output feature class must have HasMs = True, and should have an adequate M extent (MDomain) so the new measures can be set.

If there are disjoint routes, gaps will be ignored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

updateHow - The updateHow (in)

tolerance - The tolerance (in)

allRoutes - The allRoutes (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

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

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.