com.esri.arcgis.geoprocessing.tools.coveragetools
Class ArcRoute

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.ArcRoute

All Implemented Interfaces:

GPTool

public class ArcRoute
extends AbstractGPTool

Creates a route system by creating whole arc sections for each arc in the input coverage and can also be used to append arcs to an existing route system. The Line Coverage To Route tool is contained in the Coverage Tools tool box.

Usage tips:

• Creates a route system from lines or appends lines to a route system. It groups lines that are topologically connected and have unique values for the Input item to create the route system. The unique values of the Input item are always written to the Output item in the route attribute table (RAT); these values help identify routes once they have been created.
• When appending routes to an existing route system, the Output Route Item must be the name of an existing item on the route attribute table of the route system. The tool will append a section to an existing route for every input arc having an Input item equal to an Output Route Item in the route attribute table, provided the input arcs are topologically connected to the route being appended. The Measure Item on the original part of the route being appended is updated based on the measures assigned to the new sections and the specified Starting node. For those groups of arcs having values for the Input Route Item not found in the Output Route Item, a new route is created.
• Line Coverage To Route groups arcs into routes based on both the unique values in the Input Route Item and the topological connectivity of the arcs. Line Coverage To Route cannot be used to group topologically disjointed sets of arcs into the same route based on the Input Route Item.
• If the Input Route Item is a floating point, then it is truncated to integer for building the routes in the new route-system.
• Line Coverage To Route will merge two or more routes if they have the same value for the Output Route Item and become connected due to arcs being appended.
• Line Coverage To Route will not append a section to an existing route if the existing route contains overlapping sections. The input arcs are assigned to a new route instead.
• The unique values in the Input Route Item are always written to the Output Route Item in the route attribute table. Use the values in the Output Route Item to help you identify routes once they have been created.
• The Input Cover must have an arc attribute table, and node numbers must exist and be up-to-date. Use with the LINE option to create or update an arc attribute table. Use to update node numbers.
• When using the Create Route From Null Values, note that the BLANK option is considered to be zero (0.0) or null where the Input Route Item is numeric, and null where the Input Route Item is character. The Create Route From Null ValuesBLANK option is not considered if the Input Route Item is not specified.

Field Summary

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

vals

Constructor Summary

ArcRoute()
Creates the Line Coverage To Route tool with defaults.

ArcRoute(Object inCover, String outRouteSystem)
Creates the Line Coverage To Route tool with the required parameters.

Method Summary

String	getCoordinatePriority() Returns the Coordinate Priority parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getInRouteItem() Returns the Input Route Item parameter of this tool .
Object	getMeasureItem() Returns the Measure Item parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool (Read only).
String	getOutRouteItem() Returns the Output Route Item parameter of this tool .
String	getOutRouteSystem() Returns the Output Route System 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.
String	getUseBlanks() Returns the Create route from null values parameter of this tool .
void	setCoordinatePriority(String coordinatePriority) Sets the Coordinate Priority parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setInRouteItem(Object inRouteItem) Sets the Input Route Item parameter of this tool .
void	setMeasureItem(Object measureItem) Sets the Measure Item parameter of this tool .
void	setOutRouteItem(String outRouteItem) Sets the Output Route Item parameter of this tool .
void	setOutRouteSystem(String outRouteSystem) Sets the Output Route System parameter of this tool .
void	setUseBlanks(String useBlanks) Sets the Create route from null values 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

ArcRoute

public ArcRoute()

Creates the Line Coverage To Route tool with defaults.

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

ArcRoute

public ArcRoute(Object inCover,
                String outRouteSystem)

Creates the Line Coverage To Route 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:

inCover - the coverage from which the routes are to be created.

outRouteSystem - the name of the route system to be created or appended.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage from which the routes are to be created. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage from which the routes are to be created. This is a required parameter.

Parameters:

inCover - the coverage from which the routes are to be created.

getOutRouteSystem

public String getOutRouteSystem()

Returns the Output Route System parameter of this tool . This parameter is the name of the route system to be created or appended. This is a required parameter.

Returns:

the Output Route System

setOutRouteSystem

public void setOutRouteSystem(String outRouteSystem)

Sets the Output Route System parameter of this tool . This parameter is the name of the route system to be created or appended. This is a required parameter.

Parameters:

outRouteSystem - the name of the route system to be created or appended.

getInRouteItem

public Object getInRouteItem()

Returns the Input Route Item parameter of this tool . This parameter is the name of an item in the arc attribute table used to group arcs into separate routes. A new route is created in the route attribute table for each unique value in this item. The default is to create a route for each topologically connected set of arcs. This is an optional parameter.

Returns:

the Input Route Item

setInRouteItem

public void setInRouteItem(Object inRouteItem)

Sets the Input Route Item parameter of this tool . This parameter is the name of an item in the arc attribute table used to group arcs into separate routes. A new route is created in the route attribute table for each unique value in this item. The default is to create a route for each topologically connected set of arcs. This is an optional parameter.

Parameters:

inRouteItem - the name of an item in the arc attribute table used to group arcs into separate routes. A new route is created in the route attribute table for each unique value in this item. The default is to create a route for each topologically connected set of arcs.

getOutRouteItem

public String getOutRouteItem()

Returns the Output Route Item parameter of this tool . This parameter is the name of the new item in the route attribute table that will contain the unique values in the input route item. When appending routes to an existing route system, it is an existing item in the route attribute table used to append routes. The default item is Input Route Item. This is an optional parameter.

Returns:

the Output Route Item

setOutRouteItem

public void setOutRouteItem(String outRouteItem)

Sets the Output Route Item parameter of this tool . This parameter is the name of the new item in the route attribute table that will contain the unique values in the input route item. When appending routes to an existing route system, it is an existing item in the route attribute table used to append routes. The default item is Input Route Item. This is an optional parameter.

Parameters:

outRouteItem - the name of the new item in the route attribute table that will contain the unique values in the input route item. When appending routes to an existing route system, it is an existing item in the route attribute table used to append routes. The default item is Input Route Item.

getMeasureItem

public Object getMeasureItem()

Returns the Measure Item parameter of this tool . This parameter is an item in the arc attribute table of Input Coverage whose value is accumulated to produce the measure values. The default item is LENGTH. This is an optional parameter.

Returns:

the Measure Item

setMeasureItem

public void setMeasureItem(Object measureItem)

Sets the Measure Item parameter of this tool . This parameter is an item in the arc attribute table of Input Coverage whose value is accumulated to produce the measure values. The default item is LENGTH. This is an optional parameter.

Parameters:

measureItem - an item in the arc attribute table of Input Coverage whose value is accumulated to produce the measure values. The default item is LENGTH.

getCoordinatePriority

public String getCoordinatePriority()

Returns the Coordinate Priority parameter of this tool . This parameter is determines coordinate priority when choosing a start node for the route. This is an optional parameter.

Returns:

the Coordinate Priority

setCoordinatePriority

public void setCoordinatePriority(String coordinatePriority)

Sets the Coordinate Priority parameter of this tool . This parameter is determines coordinate priority when choosing a start node for the route. This is an optional parameter.

Parameters:

coordinatePriority - determines coordinate priority when choosing a start node for the route.

getUseBlanks

public String getUseBlanks()

Returns the Create route from null values parameter of this tool . This parameter is specifies whether arcs having a null or 0 value for the input route item will be used to create a route. This is an optional parameter.

Returns:

the Create route from null values

setUseBlanks

public void setUseBlanks(String useBlanks)

Sets the Create route from null values parameter of this tool . This parameter is specifies whether arcs having a null or 0 value for the input route item will be used to create a route. This is an optional parameter.

Parameters:

useBlanks - specifies whether arcs having a null or 0 value for the input route item will be used to create a route.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Coverage

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