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

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

All Implemented Interfaces:

GPTool

public class CreateRoutes
extends AbstractGPTool

Creates routes from existing lines. The input line features that share a common identifier are merged to create a single route. The Create Routes tool is contained in the Linear Referencing Tools tool box.

Usage tips:

• The unique values in the Route Identifier Field are written to Output Route Feature Class.
• Use the or tools to effectively reduce the number of lines that will be used to create routes.
• If the Output Route Feature Class will be written to a geodatabase, an appropriate , , and should be set.
• Use a Measure Factor to convert between route measure units. For example, to convert from feet to miles, use a factor of 0.00018939394.
• Use a Measure Offset in applications where the start measure of each route needs to be a value other than 0.
• The Ignore spatial gaps parameter is not used when the TWO_FIELDS Measure Source option has been specified. This is because measure values are dictated by the From-Measure Field and To-Measure Field values.
• When the LENGTH or ONE_FIELD Measure Source option is used, the Coordinate Priority is determined by placing the minimum bounding rectangle around the input features that will be merged to create one route.
• When the TWO_FIELDS Measure Source option is used, it is not necessary to specify a coordinate priority because measure direction is implied by the values in the From-Measure Field and the To-Measure Field.
• 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 Create Routes tool, 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\Create_Output0.txt (where Create_Output is the name of the output route feature class).
• The environment setting will be ignored. The Output Route Feature Class will have M (measure) values.

Field Summary

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

vals

Constructor Summary

CreateRoutes()
Creates the Create Routes tool with defaults.

CreateRoutes(java.lang.Object inLineFeatures, java.lang.Object routeIdField, java.lang.Object outFeatureClass, java.lang.String measureSource)
Creates the Create Routes tool with the required parameters.

Method Summary

java.lang.String	getBuildIndex() Returns the Build index parameter of this tool .
java.lang.String	getCoordinatePriority() Returns the Coordinate Priority parameter of this tool .
java.lang.Object	getFromMeasureField() Returns the From-Measure Field parameter of this tool .
java.lang.String	getIgnoreGaps() Returns the Ignore spatial gaps parameter of this tool .
java.lang.Object	getInLineFeatures() Returns the Input Line Features parameter of this tool .
double	getMeasureFactor() Returns the Measure Factor parameter of this tool .
double	getMeasureOffset() Returns the Measure Offset parameter of this tool .
java.lang.String	getMeasureSource() Returns the Measure Source parameter of this tool .
java.lang.Object	getOutFeatureClass() Returns the Output Route Feature Class parameter of this tool .
java.lang.Object	getRouteIdField() Returns the Route Identifier Field parameter of this tool .
java.lang.Object	getToMeasureField() Returns the To-Measure Field parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setBuildIndex(java.lang.String buildIndex) Sets the Build index parameter of this tool .
void	setCoordinatePriority(java.lang.String coordinatePriority) Sets the Coordinate Priority parameter of this tool .
void	setFromMeasureField(java.lang.Object fromMeasureField) Sets the From-Measure Field parameter of this tool .
void	setIgnoreGaps(java.lang.String ignoreGaps) Sets the Ignore spatial gaps parameter of this tool .
void	setInLineFeatures(java.lang.Object inLineFeatures) Sets the Input Line Features parameter of this tool .
void	setMeasureFactor(double measureFactor) Sets the Measure Factor parameter of this tool .
void	setMeasureOffset(double measureOffset) Sets the Measure Offset parameter of this tool .
void	setMeasureSource(java.lang.String measureSource) Sets the Measure Source parameter of this tool .
void	setOutFeatureClass(java.lang.Object outFeatureClass) Sets the Output Route Feature Class parameter of this tool .
void	setRouteIdField(java.lang.Object routeIdField) Sets the Route Identifier Field parameter of this tool .
void	setToMeasureField(java.lang.Object toMeasureField) Sets the To-Measure Field 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

CreateRoutes

public CreateRoutes()

Creates the Create Routes tool with defaults.

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

CreateRoutes

public CreateRoutes(java.lang.Object inLineFeatures,
                    java.lang.Object routeIdField,
                    java.lang.Object outFeatureClass,
                    java.lang.String measureSource)

Creates the Create 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:

inLineFeatures - the features from which routes will be created.

routeIdField - the field containing values that uniquely identify each route.

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

measureSource - specifies how route measures will be obtained.

Method Detail

getInLineFeatures

public java.lang.Object getInLineFeatures()

Returns the Input Line Features parameter of this tool . This parameter is the features from which routes will be created. This is a required parameter.

Returns:

the Input Line Features

setInLineFeatures

public void setInLineFeatures(java.lang.Object inLineFeatures)

Sets the Input Line Features parameter of this tool . This parameter is the features from which routes will be created. This is a required parameter.

Parameters:

inLineFeatures - the features from which routes will be created.

getRouteIdField

public java.lang.Object getRouteIdField()

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

Returns:

the Route Identifier Field

setRouteIdField

public void setRouteIdField(java.lang.Object routeIdField)

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

Parameters:

routeIdField - the field containing values that uniquely identify each route.

getOutFeatureClass

public java.lang.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(java.lang.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.

getMeasureSource

public java.lang.String getMeasureSource()

Returns the Measure Source parameter of this tool . This parameter is specifies how route measures will be obtained. This is a required parameter.

Returns:

the Measure Source

setMeasureSource

public void setMeasureSource(java.lang.String measureSource)

Sets the Measure Source parameter of this tool . This parameter is specifies how route measures will be obtained. This is a required parameter.

Parameters:

measureSource - specifies how route measures will be obtained.

getFromMeasureField

public java.lang.Object getFromMeasureField()

Returns the From-Measure Field parameter of this tool . This parameter is a field containing measure values. This field must be numeric and is required when the measure source is ONE_FIELD or TWO_FIELDS. This is an optional parameter.

Returns:

the From-Measure Field

setFromMeasureField

public void setFromMeasureField(java.lang.Object fromMeasureField)

Sets the From-Measure Field parameter of this tool . This parameter is a field containing measure values. This field must be numeric and is required when the measure source is ONE_FIELD or TWO_FIELDS. This is an optional parameter.

Parameters:

fromMeasureField - a field containing measure values. This field must be numeric and is required when the measure source is ONE_FIELD or TWO_FIELDS.

getToMeasureField

public java.lang.Object getToMeasureField()

Returns the To-Measure Field parameter of this tool . This parameter is a field containing measure values. This field must be numeric and is required when the measure source is TWO_FIELDS. This is an optional parameter.

Returns:

the To-Measure Field

setToMeasureField

public void setToMeasureField(java.lang.Object toMeasureField)

Sets the To-Measure Field parameter of this tool . This parameter is a field containing measure values. This field must be numeric and is required when the measure source is TWO_FIELDS. This is an optional parameter.

Parameters:

toMeasureField - a field containing measure values. This field must be numeric and is required when the measure source is TWO_FIELDS.

getCoordinatePriority

public java.lang.String getCoordinatePriority()

Returns the Coordinate Priority parameter of this tool . This parameter is the position from which measures will be accumulated for each output route. This parameter is ignored when the measure source is TWO_FIELDS. This is an optional parameter.

Returns:

the Coordinate Priority

setCoordinatePriority

public void setCoordinatePriority(java.lang.String coordinatePriority)

Sets the Coordinate Priority parameter of this tool . This parameter is the position from which measures will be accumulated for each output route. This parameter is ignored when the measure source is TWO_FIELDS. This is an optional parameter.

Parameters:

coordinatePriority - the position from which measures will be accumulated for each output route. This parameter is ignored when the measure source is TWO_FIELDS.

getMeasureFactor

public double getMeasureFactor()

Returns the Measure Factor parameter of this tool . This parameter is a value multiplied by the measure length of each input line before they are merged to create route measures. The default is 1. This is an optional parameter.

Returns:

the Measure Factor

setMeasureFactor

public void setMeasureFactor(double measureFactor)

Sets the Measure Factor parameter of this tool . This parameter is a value multiplied by the measure length of each input line before they are merged to create route measures. The default is 1. This is an optional parameter.

Parameters:

measureFactor - a value multiplied by the measure length of each input line before they are merged to create route measures. The default is 1.

getMeasureOffset

public double getMeasureOffset()

Returns the Measure Offset parameter of this tool . This parameter is a value added to the route measures after the input lines have been merged to create a route. The default is 0. This is an optional parameter.

Returns:

the Measure Offset

setMeasureOffset

public void setMeasureOffset(double measureOffset)

Sets the Measure Offset parameter of this tool . This parameter is a value added to the route measures after the input lines have been merged to create a route. The default is 0. This is an optional parameter.

Parameters:

measureOffset - a value added to the route measures after the input lines have been merged to create a route. The default is 0.

getIgnoreGaps

public java.lang.String getIgnoreGaps()

Returns the Ignore spatial gaps parameter of this tool . This parameter is specifies whether spatial gaps will be ignored when calculating the measures on disjointed routes. This parameter is applicable when the measure source is LENGTH or ONE_FIELD. This is an optional parameter.

Returns:

the Ignore spatial gaps

setIgnoreGaps

public void setIgnoreGaps(java.lang.String ignoreGaps)

Sets the Ignore spatial gaps parameter of this tool . This parameter is specifies whether spatial gaps will be ignored when calculating the measures on disjointed routes. This parameter is applicable when the measure source is LENGTH or ONE_FIELD. This is an optional parameter.

Parameters:

ignoreGaps - specifies whether spatial gaps will be ignored when calculating the measures on disjointed routes. This parameter is applicable when the measure source is LENGTH or ONE_FIELD.

getBuildIndex

public java.lang.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(java.lang.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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias