com.esri.arcgis.networkanalyst
Interface INACompactStreetDirections

All Superinterfaces:
Serializable

public interface INACompactStreetDirections
extends Serializable

Provides access to compact driving directions.

Remarks

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

Product Availability

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


Method Summary
 INACompactStreetDirection getDirection(int index)
          The direction by index.
 int getDirectionCount()
          The directions count.
 int getRouteID()
          The route ID for the directions.
 String getRouteName()
          The route name for the directions.
 INACompactStreetDirectionSummary getSummary()
          The summary information.
 

Method Detail

getRouteID

int getRouteID()
               throws IOException,
                      AutomationException
The route ID for the directions.

Remarks

RouteID returns the ObjectID of the corresponding route feature in the Routes or CFRoutes network analysis class.

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. This is retrieved from the name field of the corresponding route feature in the Routes or CFRoutes network analysis class.

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 directions count.

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

INACompactStreetDirection getDirection(int index)
                                       throws IOException,
                                              AutomationException
The direction 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.INACompactStreetDirection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSummary

INACompactStreetDirectionSummary getSummary()
                                            throws IOException,
                                                   AutomationException
The summary information.

Remarks

Summary gives access to INACompactStreetDirectionSummary 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.INACompactStreetDirectionSummary
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.