com.esri.arcgis.location
Class RouteMeasureCalibrator

java.lang.Object
  com.esri.arcgis.location.RouteMeasureCalibrator

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureCalibrator, IRouteMeasureCalibrator2, ISupportErrorInfo, Serializable

public class RouteMeasureCalibrator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureCalibrator, IRouteMeasureCalibrator2, ISupportErrorInfo

Route Measure Calibration Object.

Remarks

The RouteMeasureCalibrator CoClass lets you calibrate the measures of the PolylineM feature class by calibration points stored in a Point or Multipoint feature class. The Point or Multipoint feature class needs to contain a field to define the route identifier (InputRouteIDFieldName), which route each point feature refers to, and a measure field to define the new measure at the point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RouteMeasureCalibrator()
Constructs a RouteMeasureCalibrator using ArcGIS Engine.

RouteMeasureCalibrator(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureCalibrator theRouteMeasureCalibrator = (RouteMeasureCalibrator) obj;

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.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
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.
IRouteLocator	getRouteLocator() The route locator.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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	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.
void	setRouteLocatorByRef(IRouteLocator routeLocator) The route locator.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RouteMeasureCalibrator

public RouteMeasureCalibrator()
                       throws IOException,
                              UnknownHostException

Constructs a RouteMeasureCalibrator using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RouteMeasureCalibrator

public RouteMeasureCalibrator(Object obj)
                       throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureCalibrator theRouteMeasureCalibrator = (RouteMeasureCalibrator) obj;

Construct a RouteMeasureCalibrator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RouteMeasureCalibrator.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setRouteLocatorByRef

public 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

Specified by:

setRouteLocatorByRef in interface IRouteMeasureCalibrator

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

public 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

Specified by:

getRouteLocator in interface IRouteMeasureCalibrator

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

public 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

Specified by:

setInputFeatureClassByRef in interface IRouteMeasureCalibrator

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

public 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

Specified by:

getInputFeatureClass in interface IRouteMeasureCalibrator

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

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

Specified by:

setInputFeatureSelectionByRef in interface IRouteMeasureCalibrator

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

public 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

Specified by:

getInputFeatureSelection in interface IRouteMeasureCalibrator

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

public 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

Specified by:

setInputRouteIDFieldName in interface IRouteMeasureCalibrator

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputRouteIDFieldName

public 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

Specified by:

getInputRouteIDFieldName in interface IRouteMeasureCalibrator

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputMeasureFieldName

public 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

Specified by:

setInputMeasureFieldName in interface IRouteMeasureCalibrator

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputMeasureFieldName

public 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

Specified by:

getInputMeasureFieldName in interface IRouteMeasureCalibrator

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildOutputIndex

public 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

Specified by:

setBuildOutputIndex in interface IRouteMeasureCalibrator

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildOutputIndex

public 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

Specified by:

isBuildOutputIndex in interface IRouteMeasureCalibrator

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calibrateRoutesByDistance

public 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

Specified by:

calibrateRoutesByDistance in interface IRouteMeasureCalibrator

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

public 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

Specified by:

calibrateRoutesByMs in interface IRouteMeasureCalibrator

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.

setRouteFeatureClassByRef

public 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

Specified by:

setRouteFeatureClassByRef in interface IRouteMeasureCalibrator2

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

public 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

Specified by:

getRouteFeatureClass in interface IRouteMeasureCalibrator2

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

public 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

Specified by:

setRouteFeatureSelectionByRef in interface IRouteMeasureCalibrator2

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

public 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

Specified by:

getRouteFeatureSelection in interface IRouteMeasureCalibrator2

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

public 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

Specified by:

setRouteIDFieldName in interface IRouteMeasureCalibrator2

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

public 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

Specified by:

getRouteIDFieldName in interface IRouteMeasureCalibrator2

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.