com.esri.arcgis.geoprocessing.tools.linearreferencingtools
Class CalibrateRoutes

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.linearreferencingtools.CalibrateRoutes

All Implemented Interfaces:

GPTool

public class CalibrateRoutes
extends AbstractGPTool

Recalculates route measures using points. The Calibrate Routes tool is contained in the Linear Referencing Tools tool box.

Usage tips:

• Either whole or partial routes can be calibrated. You can choose to interpolate between the input points, extrapolate before the input points, extrapolate after the input points, or use any combination of these three methods.
• Use or to effectively reduce the routes that will be calibrated.
• If the Output Route Feature Class will be written to a geodatabase, an appropriate , , and should be set.
• The Output Route Feature Class will include all the fields from the Input Route Features.
• The environment setting will be ignored. The Output Route Feature Class will have M (measure) values.
• A search radius of infinity cannot be specified.
• An attribute index on the route identifier field speeds up the dynamic segmentation process. If you will be using the Output Route Feature Class for , it is recommended that you choose to have an attribute index created.
• If any features are rejected by the Calibrate Routes process, a text file is created in the temporary file path to store information about those features. For example, C:\Documents and Settings\patrickb\Local Settings\Temp\Calibrate_Output0.txt (where 'Calibrate_Output' is the name of the Output Route Feature Class).

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CalibrateRoutes()
Creates the Calibrate Routes tool with defaults.

CalibrateRoutes(Object inRouteFeatures, Object routeIdField, Object inPointFeatures, Object pointIdField, Object measureField, Object outFeatureClass)
Creates the Calibrate Routes tool with the required parameters.

Method Summary

String	getBuildIndex() Returns the Build index parameter of this tool .
String	getCalibrateMethod() Returns the Measure Calculation Method parameter of this tool .
String	getExtrapolateAfter() Returns the Extrapolate after calibration points parameter of this tool .
String	getExtrapolateBefore() Returns the Extrapolate before calibration points parameter of this tool .
String	getIgnoreGaps() Returns the Ignore spatial gaps parameter of this tool .
Object	getInPointFeatures() Returns the Input Point Features parameter of this tool .
Object	getInRouteFeatures() Returns the Input Route Features parameter of this tool .
String	getInterpolateBetween() Returns the Interpolate between calibration points parameter of this tool .
String	getKeepAllRoutes() Returns the Include all features in the output feature class parameter of this tool .
Object	getMeasureField() Returns the Measure Field parameter of this tool .
Object	getOutFeatureClass() Returns the Output Route Feature Class parameter of this tool .
Object	getPointIdField() Returns the Point Identifier Field parameter of this tool .
Object	getRouteIdField() Returns the Route Identifier Field parameter of this tool .
Object	getSearchRadius() Returns the Search Radius parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setBuildIndex(String buildIndex) Sets the Build index parameter of this tool .
void	setCalibrateMethod(String calibrateMethod) Sets the Measure Calculation Method parameter of this tool .
void	setExtrapolateAfter(String extrapolateAfter) Sets the Extrapolate after calibration points parameter of this tool .
void	setExtrapolateBefore(String extrapolateBefore) Sets the Extrapolate before calibration points parameter of this tool .
void	setIgnoreGaps(String ignoreGaps) Sets the Ignore spatial gaps parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input Point Features parameter of this tool .
void	setInRouteFeatures(Object inRouteFeatures) Sets the Input Route Features parameter of this tool .
void	setInterpolateBetween(String interpolateBetween) Sets the Interpolate between calibration points parameter of this tool .
void	setKeepAllRoutes(String keepAllRoutes) Sets the Include all features in the output feature class parameter of this tool .
void	setMeasureField(Object measureField) Sets the Measure Field parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Route Feature Class parameter of this tool .
void	setPointIdField(Object pointIdField) Sets the Point Identifier Field parameter of this tool .
void	setRouteIdField(Object routeIdField) Sets the Route Identifier Field parameter of this tool .
void	setSearchRadius(Object searchRadius) Sets the Search Radius parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CalibrateRoutes

public CalibrateRoutes()

Creates the Calibrate Routes tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

CalibrateRoutes

public CalibrateRoutes(Object inRouteFeatures,
                       Object routeIdField,
                       Object inPointFeatures,
                       Object pointIdField,
                       Object measureField,
                       Object outFeatureClass)

Creates the Calibrate Routes tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRouteFeatures - the route features to be calibrated.

routeIdField - the field containing values that uniquely identify each route. This field can be numeric or character.

inPointFeatures - the point features used to calibrate the routes.

pointIdField - the field that identifies the route on which each calibration point is located. The values in this field match those in the route identifier field. This field can be numeric or character.

measureField - the field containing the measure value for each calibration point. This field must be numeric.

outFeatureClass - the feature class to be created. It can be a shapefile or a geodatabase feature class.

Method Detail

getInRouteFeatures

public Object getInRouteFeatures()

Returns the Input Route Features parameter of this tool . This parameter is the route features to be calibrated. This is a required parameter.

Returns:

the Input Route Features

setInRouteFeatures

public void setInRouteFeatures(Object inRouteFeatures)

Sets the Input Route Features parameter of this tool . This parameter is the route features to be calibrated. This is a required parameter.

Parameters:

inRouteFeatures - the route features to be calibrated.

getRouteIdField

public Object getRouteIdField()

Returns the Route Identifier Field parameter of this tool . This parameter is the field containing values that uniquely identify each route. This field can be numeric or character. This is a required parameter.

Returns:

the Route Identifier Field

setRouteIdField

public void setRouteIdField(Object routeIdField)

Sets the Route Identifier Field parameter of this tool . This parameter is the field containing values that uniquely identify each route. This field can be numeric or character. This is a required parameter.

Parameters:

routeIdField - the field containing values that uniquely identify each route. This field can be numeric or character.

getInPointFeatures

public Object getInPointFeatures()

Returns the Input Point Features parameter of this tool . This parameter is the point features used to calibrate the routes. This is a required parameter.

Returns:

the Input Point Features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input Point Features parameter of this tool . This parameter is the point features used to calibrate the routes. This is a required parameter.

Parameters:

inPointFeatures - the point features used to calibrate the routes.

getPointIdField

public Object getPointIdField()

Returns the Point Identifier Field parameter of this tool . This parameter is the field that identifies the route on which each calibration point is located. The values in this field match those in the route identifier field. This field can be numeric or character. This is a required parameter.

Returns:

the Point Identifier Field

setPointIdField

public void setPointIdField(Object pointIdField)

Sets the Point Identifier Field parameter of this tool . This parameter is the field that identifies the route on which each calibration point is located. The values in this field match those in the route identifier field. This field can be numeric or character. This is a required parameter.

Parameters:

pointIdField - the field that identifies the route on which each calibration point is located. The values in this field match those in the route identifier field. This field can be numeric or character.

getMeasureField

public Object getMeasureField()

Returns the Measure Field parameter of this tool . This parameter is the field containing the measure value for each calibration point. This field must be numeric. This is a required parameter.

Returns:

the Measure Field

setMeasureField

public void setMeasureField(Object measureField)

Sets the Measure Field parameter of this tool . This parameter is the field containing the measure value for each calibration point. This field must be numeric. This is a required parameter.

Parameters:

measureField - the field containing the measure value for each calibration point. This field must be numeric.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Route Feature Class parameter of this tool . This parameter is the feature class to be created. It can be a shapefile or a geodatabase feature class. This is a required parameter.

Returns:

the Output Route Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Route Feature Class parameter of this tool . This parameter is the feature class to be created. It can be a shapefile or a geodatabase feature class. This is a required parameter.

Parameters:

outFeatureClass - the feature class to be created. It can be a shapefile or a geodatabase feature class.

getCalibrateMethod

public String getCalibrateMethod()

Returns the Measure Calculation Method parameter of this tool . This parameter is specifies how route measures will be recalculated. This is an optional parameter.

Returns:

the Measure Calculation Method

setCalibrateMethod

public void setCalibrateMethod(String calibrateMethod)

Sets the Measure Calculation Method parameter of this tool . This parameter is specifies how route measures will be recalculated. This is an optional parameter.

Parameters:

calibrateMethod - specifies how route measures will be recalculated.

getSearchRadius

public Object getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is limits how far a calibration point can be from a route by specifying the distance and its unit of measure. If the units of measure are Unknown, the same units as the coordinate system of the route feature class will be used. This is an optional parameter.

Returns:

the Search Radius

setSearchRadius

public void setSearchRadius(Object searchRadius)

Sets the Search Radius parameter of this tool . This parameter is limits how far a calibration point can be from a route by specifying the distance and its unit of measure. If the units of measure are Unknown, the same units as the coordinate system of the route feature class will be used. This is an optional parameter.

Parameters:

searchRadius - limits how far a calibration point can be from a route by specifying the distance and its unit of measure. If the units of measure are Unknown, the same units as the coordinate system of the route feature class will be used.

getInterpolateBetween

public String getInterpolateBetween()

Returns the Interpolate between calibration points parameter of this tool . This parameter is specifies whether measure values will be interpolated between the calibration points. This is an optional parameter.

Returns:

the Interpolate between calibration points

setInterpolateBetween

public void setInterpolateBetween(String interpolateBetween)

Sets the Interpolate between calibration points parameter of this tool . This parameter is specifies whether measure values will be interpolated between the calibration points. This is an optional parameter.

Parameters:

interpolateBetween - specifies whether measure values will be interpolated between the calibration points.

getExtrapolateBefore

public String getExtrapolateBefore()

Returns the Extrapolate before calibration points parameter of this tool . This parameter is specifies whether measure values will be extrapolated before the calibration points. This is an optional parameter.

Returns:

the Extrapolate before calibration points

setExtrapolateBefore

public void setExtrapolateBefore(String extrapolateBefore)

Sets the Extrapolate before calibration points parameter of this tool . This parameter is specifies whether measure values will be extrapolated before the calibration points. This is an optional parameter.

Parameters:

extrapolateBefore - specifies whether measure values will be extrapolated before the calibration points.

getExtrapolateAfter

public String getExtrapolateAfter()

Returns the Extrapolate after calibration points parameter of this tool . This parameter is specifies whether measure values will be extrapolated after the calibration points. This is an optional parameter.

Returns:

the Extrapolate after calibration points

setExtrapolateAfter

public void setExtrapolateAfter(String extrapolateAfter)

Sets the Extrapolate after calibration points parameter of this tool . This parameter is specifies whether measure values will be extrapolated after the calibration points. This is an optional parameter.

Parameters:

extrapolateAfter - specifies whether measure values will be extrapolated after the calibration points.

getIgnoreGaps

public String getIgnoreGaps()

Returns the Ignore spatial gaps parameter of this tool . This parameter is specifies whether spatial gaps will be ignored when recalculating the measures on disjointed routes. This is an optional parameter.

Returns:

the Ignore spatial gaps

setIgnoreGaps

public void setIgnoreGaps(String ignoreGaps)

Sets the Ignore spatial gaps parameter of this tool . This parameter is specifies whether spatial gaps will be ignored when recalculating the measures on disjointed routes. This is an optional parameter.

Parameters:

ignoreGaps - specifies whether spatial gaps will be ignored when recalculating the measures on disjointed routes.

getKeepAllRoutes

public String getKeepAllRoutes()

Returns the Include all features in the output feature class parameter of this tool . This parameter is specifies whether route features that do not have any calibration points will be excluded from the output feature class. This is an optional parameter.

Returns:

the Include all features in the output feature class

setKeepAllRoutes

public void setKeepAllRoutes(String keepAllRoutes)

Sets the Include all features in the output feature class parameter of this tool . This parameter is specifies whether route features that do not have any calibration points will be excluded from the output feature class. This is an optional parameter.

Parameters:

keepAllRoutes - specifies whether route features that do not have any calibration points will be excluded from the output feature class.

getBuildIndex

public String getBuildIndex()

Returns the Build index parameter of this tool . This parameter is specifies whether an attribute index will be created for the route identifier field that is written to the Output Route Feature Class. This is an optional parameter.

Returns:

the Build index

setBuildIndex

public void setBuildIndex(String buildIndex)

Sets the Build index parameter of this tool . This parameter is specifies whether an attribute index will be created for the route identifier field that is written to the Output Route Feature Class. This is an optional parameter.

Parameters:

buildIndex - specifies whether an attribute index will be created for the route identifier field that is written to the Output Route Feature Class.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias