com.esri.arcgis.networkanalyst
Interface INAStreetDirectionsContainer

All Superinterfaces:
Serializable
All Known Implementing Classes:
INAStreetDirectionsContainerProxy

public interface INAStreetDirectionsContainer
extends Serializable

Provides access to a container for driving directions.

Remarks

The INAStreetDirectionsContainer interface provides access to the directions contents and a method to save the contents in a file in XML format.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 INAStreetDirections getDirections(int index)
          The route directions by index.
 int getDirectionsCount()
          The count of routes for the generated directions.
 void saveAsXML(String filename)
          Saves the directions to a file in XML format.
 

Method Detail

getDirectionsCount

int getDirectionsCount()
                       throws IOException,
                              AutomationException
The count of routes for the generated directions.

Remarks

DirectionsCount returns the number of NAStreetDirections objects that were generated based on the number of routes passed in to INAStreetDirectionsAgent::Execute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirections

INAStreetDirections getDirections(int index)
                                  throws IOException,
                                         AutomationException
The route directions by index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAStreetDirections
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAsXML

void saveAsXML(String filename)
               throws IOException,
                      AutomationException
Saves the directions to a file in XML format.

Remarks

SaveAsXML saves all of the directions into an XML file.

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
filename - The filename (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.