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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.linearreferencingtools.CalibrateRoutes
All Implemented Interfaces:
GPTool

public class CalibrateRoutes
extends AbstractGPTool

Recalculates The Calibrate Routes tool is contained in the Linear Referencing Tools tool box.

Software restrictions: none

Usage tips:


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 - Feature Layer, the route features to be calibrated.
routeIdField - Field, the field containing values that uniquely identify each route. This field can be numeric or character.
inPointFeatures - Feature Layer, the point features used to calibrate the routes.
pointIdField - Field, the field that identifies the route on which each calibration point is. The values in this field match those in the route identifier field. This field can be numeric or character.
measureField - Field, the field containing the measure value for each calibration point. This field must be numeric.
outFeatureClass - Feature Class, 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 Feature Layer, 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 Feature Layer, the route features to be calibrated. This is a required parameter.

Parameters:
inRouteFeatures - Feature Layer, the route features to be calibrated.

getRouteIdField

public Object getRouteIdField()
Returns the Route Identifier Field parameter of this tool . This parameter is Field, 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 Field, the field containing values that uniquely identify each route. This field can be numeric or character. This is a required parameter.

Parameters:
routeIdField - Field, 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 Feature Layer, 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 Feature Layer, the point features used to calibrate the routes. This is a required parameter.

Parameters:
inPointFeatures - Feature Layer, the point features used to calibrate the routes.

getPointIdField

public Object getPointIdField()
Returns the Point Identifier Field parameter of this tool . This parameter is Field, the field that identifies the route on which each calibration point is. 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 Field, the field that identifies the route on which each calibration point is. 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 - Field, the field that identifies the route on which each calibration point is. 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 Field, 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 Field, the field containing the measure value for each calibration point. This field must be numeric. This is a required parameter.

Parameters:
measureField - Field, 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 Feature Class, 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 Feature Class, the feature class to be created. It can be a shapefile or a geodatabase feature class. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, 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 String, 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 String, specifies how route measures will be recalculated. This is an optional parameter.

Parameters:
calibrateMethod - String, specifies how route measures will be recalculated.

getSearchRadius

public Object getSearchRadius()
Returns the Search Radius parameter of this tool . This parameter is Linear unit, 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 Linear unit, 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 - Linear unit, 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 String, 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 String, specifies whether measure values will be interpolated between the calibration points. This is an optional parameter.

Parameters:
interpolateBetween - String, 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 String, 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 String, specifies whether measure values will be extrapolated before the calibration points. This is an optional parameter.

Parameters:
extrapolateBefore - String, 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 String, 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 String, specifies whether measure values will be extrapolated after the calibration points. This is an optional parameter.

Parameters:
extrapolateAfter - String, 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 String, 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 String, specifies whether spatial gaps will be ignored when recalculating the measures on disjointed routes. This is an optional parameter.

Parameters:
ignoreGaps - String, 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 String, 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 String, 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 - String, 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 String, 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 String, 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 - String, 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