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

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

public class ArcRoute
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. 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.

Software restrictions: ArcInfo only

Usage tips:


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 - Coverage, the coverage from which the routes are to be created.
outRouteSystem - String, 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 Coverage, 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 Coverage, the coverage from which the routes are to be created. This is a required parameter.

Parameters:
inCover - Coverage, 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 String, 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 String, the name of the route system to be created or appended. This is a required parameter.

Parameters:
outRouteSystem - String, 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 ArcInfo Item, 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 ArcInfo Item, 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 - ArcInfo Item, 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 String, 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 String, 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 - String, 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 ArcInfo Item, 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 ArcInfo Item, 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 - ArcInfo Item, 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 String, determines coordinate priority when choosing a start node for the route. These can be upper left (UL), upper right (UR), lower left (LL), or lower right (LR). Default is upper left (UL). 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 String, determines coordinate priority when choosing a start node for the route. These can be upper left (UL), upper right (UR), lower left (LL), or lower right (LR). Default is upper left (UL). This is an optional parameter.

Parameters:
coordinatePriority - String, determines coordinate priority when choosing a start node for the route. These can be upper left (UL), upper right (UR), lower left (LL), or lower right (LR). Default is upper left (UL).

getUseBlanks

public String getUseBlanks()
Returns the Create route from null values parameter of this tool . This parameter is String, 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 String, 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 - String, 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