com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class Directions

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.networkanalysttools.Directions

All Implemented Interfaces:

GPTool

public class Directions
extends AbstractGPTool

Generates direction information from a network analysis layer with routes. The direction information is written to a file in either XML or text format. The Directions tool is contained in the Network Analyst Tools tool box.

Usage tips:

• The tool solves the network analysis layer if it does not have a valid result. So it is not required to solve the network analysis layer before generating directions.
• The output XML file containing directions can be converted into a properly formatted HTML file using the style sheets available in the ArcGIS installation folder. For example, the directions output in XML format can be converted into an HTML file or a Text file using the style sheet Dir2WebDocument.xsl or Dir2PlainText.xsl, respectively (usually found at C:\Program Files\ArcGIS\Desktop10.0\NetworkAnalyst\Directions\Styles). Note that you will need a custom tool that transforms an XML file into an HTML file using the style sheets.

Field Summary

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

vals

Constructor Summary

Directions()
Creates the Directions tool with defaults.

Directions(java.lang.Object inNetworkAnalysisLayer, java.lang.String fileType, java.lang.Object outDirectionsFile, java.lang.String reportUnits)
Creates the Directions tool with the required parameters.

Method Summary

java.lang.String	getFileType() Returns the Output file type parameter of this tool .
java.lang.Object	getInNetworkAnalysisLayer() Returns the Input network analysis layer parameter of this tool .
java.lang.Object	getOutDirectionsFile() Returns the Output directions file parameter of this tool .
java.lang.Object	getOutputLayer() Returns the Network Analyst Layer parameter of this tool (Read only).
java.lang.String	getReportTime() Returns the Report travel time parameter of this tool .
java.lang.String	getReportUnits() Returns the Report length in these units parameter of this tool .
java.lang.String	getTimeAttribute() Returns the Time attribute 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	setFileType(java.lang.String fileType) Sets the Output file type parameter of this tool .
void	setInNetworkAnalysisLayer(java.lang.Object inNetworkAnalysisLayer) Sets the Input network analysis layer parameter of this tool .
void	setOutDirectionsFile(java.lang.Object outDirectionsFile) Sets the Output directions file parameter of this tool .
void	setReportTime(java.lang.String reportTime) Sets the Report travel time parameter of this tool .
void	setReportUnits(java.lang.String reportUnits) Sets the Report length in these units parameter of this tool .
void	setTimeAttribute(java.lang.String timeAttribute) Sets the Time attribute 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

Directions

public Directions()

Creates the Directions tool with defaults.

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

Directions

public Directions(java.lang.Object inNetworkAnalysisLayer,
                  java.lang.String fileType,
                  java.lang.Object outDirectionsFile,
                  java.lang.String reportUnits)

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

inNetworkAnalysisLayer - network analysis layer from which directions will be generated. Directions can be generated only for the Route, Closest Facility, and Vehicle Routing Problem network analysis layers.

fileType - the format of the output directions file.

outDirectionsFile - the full pathname to the directions file that will be written.

reportUnits - specifies the linear units in which the length information will be reported in the directions file. For example, even though your impedance was in meters, you can show directions in miles.

Method Detail

getInNetworkAnalysisLayer

public java.lang.Object getInNetworkAnalysisLayer()

Returns the Input network analysis layer parameter of this tool . This parameter is network analysis layer from which directions will be generated. Directions can be generated only for the Route, Closest Facility, and Vehicle Routing Problem network analysis layers. This is a required parameter.

Returns:

the Input network analysis layer

setInNetworkAnalysisLayer

public void setInNetworkAnalysisLayer(java.lang.Object inNetworkAnalysisLayer)

Sets the Input network analysis layer parameter of this tool . This parameter is network analysis layer from which directions will be generated. Directions can be generated only for the Route, Closest Facility, and Vehicle Routing Problem network analysis layers. This is a required parameter.

Parameters:

inNetworkAnalysisLayer - network analysis layer from which directions will be generated. Directions can be generated only for the Route, Closest Facility, and Vehicle Routing Problem network analysis layers.

getFileType

public java.lang.String getFileType()

Returns the Output file type parameter of this tool . This parameter is the format of the output directions file. This is a required parameter.

Returns:

the Output file type

setFileType

public void setFileType(java.lang.String fileType)

Sets the Output file type parameter of this tool . This parameter is the format of the output directions file. This is a required parameter.

Parameters:

fileType - the format of the output directions file.

getOutDirectionsFile

public java.lang.Object getOutDirectionsFile()

Returns the Output directions file parameter of this tool . This parameter is the full pathname to the directions file that will be written. This is a required parameter.

Returns:

the Output directions file

setOutDirectionsFile

public void setOutDirectionsFile(java.lang.Object outDirectionsFile)

Sets the Output directions file parameter of this tool . This parameter is the full pathname to the directions file that will be written. This is a required parameter.

Parameters:

outDirectionsFile - the full pathname to the directions file that will be written.

getReportUnits

public java.lang.String getReportUnits()

Returns the Report length in these units parameter of this tool . This parameter is specifies the linear units in which the length information will be reported in the directions file. For example, even though your impedance was in meters, you can show directions in miles. This is a required parameter.

Returns:

the Report length in these units

setReportUnits

public void setReportUnits(java.lang.String reportUnits)

Sets the Report length in these units parameter of this tool . This parameter is specifies the linear units in which the length information will be reported in the directions file. For example, even though your impedance was in meters, you can show directions in miles. This is a required parameter.

Parameters:

reportUnits - specifies the linear units in which the length information will be reported in the directions file. For example, even though your impedance was in meters, you can show directions in miles.

getReportTime

public java.lang.String getReportTime()

Returns the Report travel time parameter of this tool . This is an optional parameter.

Returns:

the Report travel time

setReportTime

public void setReportTime(java.lang.String reportTime)

Sets the Report travel time parameter of this tool . This is an optional parameter.

Parameters:

reportTime - null

getTimeAttribute

public java.lang.String getTimeAttribute()

Returns the Time attribute parameter of this tool . This parameter is the time-based cost attribute providing the travel times in the directions. The cost attribute must exist on the network dataset used by the input network analysis layer. This is an optional parameter.

Returns:

the Time attribute

setTimeAttribute

public void setTimeAttribute(java.lang.String timeAttribute)

Sets the Time attribute parameter of this tool . This parameter is the time-based cost attribute providing the travel times in the directions. The cost attribute must exist on the network dataset used by the input network analysis layer. This is an optional parameter.

Parameters:

timeAttribute - the time-based cost attribute providing the travel times in the directions. The cost attribute must exist on the network dataset used by the input network analysis layer.

getOutputLayer

public java.lang.Object getOutputLayer()

Returns the Network Analyst Layer parameter of this tool (Read only). This is an derived parameter.

Returns:

the Network Analyst Layer

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