com.esri.arcgis.networkanalyst
Interface INAStreetDirections

All Superinterfaces:

Serializable

All Known Implementing Classes:

INAStreetDirectionsProxy

public interface INAStreetDirections
extends Serializable

Provides access to the driving directions.

Remarks

The INAStreetDirections interface provides access to the NAStreetDirections object which holds street directions for a particular route.

Product Availability

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

Method Summary

INAStreetDirection	getDirection(int index) The direction item by index.
int	getDirectionCount() The number of direction items.
int	getRouteID() The route ID for the directions.
String	getRouteName() The route name for the directions.
INAStreetDirection	getSummary() The summary information.

Method Detail

getRouteID

int getRouteID()
               throws IOException,
                      AutomationException

The route ID for the directions.

Remarks

RouteID returns the ID of the route.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteName

String getRouteName()
                    throws IOException,
                           AutomationException

The route name for the directions.

Remarks

RouteName returns the name of the route.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionCount

int getDirectionCount()
                      throws IOException,
                             AutomationException

The number of direction items.

Remarks

DirectionsCount returns the number of individual step-by-step directions associated with the route.

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.

getDirection

INAStreetDirection getDirection(int index)
                                throws IOException,
                                       AutomationException

The direction item 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.INAStreetDirection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSummary

INAStreetDirection getSummary()
                              throws IOException,
                                     AutomationException

The summary information.

Remarks

Summary gives access to INAStreetDirection which provides a summary of the route (e.g. total distance).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAStreetDirection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.