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 for 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.

Software restrictions: none

Usage tips:

• Directions cannot not be generated for analysis layer files (.lyr), only for analysis layers in the ArcMap Table of Contents or layers created in the same application session, script, or model as the Directions command is run.
• 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\NetworkAnalyst\Directions\Styles).
• The following environment settings affect this tool: workspace;

Field Summary

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

vals

Constructor Summary

Directions()
Creates the Directions tool with defaults.

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

Method Summary

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

fileType - String, the format of the output directions file.

outDirectionsFile - File, the full pathname of the directions file that will be written.

reportUnits - String, the units in which the length information will be reported in the directions file.

Method Detail

getInNetworkAnalysisLayer

public Object getInNetworkAnalysisLayer()

Returns the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, network analysis layer from which directions will be generated. This is a required parameter.

Returns:

the Input network analysis layer

setInNetworkAnalysisLayer

public void setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer)

Sets the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, network analysis layer from which directions will be generated. This is a required parameter.

Parameters:

inNetworkAnalysisLayer - Network Analyst Layer, network analysis layer from which directions will be generated.

getFileType

public String getFileType()

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

Returns:

the Output file type

setFileType

public void setFileType(String fileType)

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

Parameters:

fileType - String, the format of the output directions file.

getOutDirectionsFile

public Object getOutDirectionsFile()

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

Returns:

the Output directions file

setOutDirectionsFile

public void setOutDirectionsFile(Object outDirectionsFile)

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

Parameters:

outDirectionsFile - File, the full pathname of the directions file that will be written.

getReportUnits

public String getReportUnits()

Returns the Report length in these units parameter of this tool . This parameter is String, the units in which the length information will be reported in the directions file. This is a required parameter.

Returns:

the Report length in these units

setReportUnits

public void setReportUnits(String reportUnits)

Sets the Report length in these units parameter of this tool . This parameter is String, the units in which the length information will be reported in the directions file. This is a required parameter.

Parameters:

reportUnits - String, the units in which the length information will be reported in the directions file.

getReportTime

public String getReportTime()

Returns the Report travel time parameter of this tool . This parameter is String, specifies whether to report travel times in the directions file. This is an optional parameter.

Returns:

the Report travel time

setReportTime

public void setReportTime(String reportTime)

Sets the Report travel time parameter of this tool . This parameter is String, specifies whether to report travel times in the directions file. This is an optional parameter.

Parameters:

reportTime - String, specifies whether to report travel times in the directions file.

getTimeAttribute

public String getTimeAttribute()

Returns the Time attribute parameter of this tool . This parameter is String, the cost attribute providing the travel times to the directions. This is an optional parameter.

Returns:

the Time attribute

setTimeAttribute

public void setTimeAttribute(String timeAttribute)

Sets the Time attribute parameter of this tool . This parameter is String, the cost attribute providing the travel times to the directions. This is an optional parameter.

Parameters:

timeAttribute - String, the cost attribute providing the travel times to the directions.

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