com.esri.arcgis.networkanalyst
Interface INAStreetDirectionsAgent

All Superinterfaces:

Serializable

All Known Subinterfaces:

INAStreetDirectionsAgent2, INAStreetDirectionsAgent3

All Known Implementing Classes:

NAStreetDirectionsAgent

public interface INAStreetDirectionsAgent
extends Serializable

Provides access to the Directions Agent.

Superseded By

INAStreetDirectionsAgent2

Remarks

INAStreetDirectionsAgent has been superseded by INAStreetDirectionsAgent3.

Product Availability

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

Method Summary

void	execute(ISet set, ITrackCancel trackCancel) Constructs the directions.
INAStreetDirectionsContainer	getDirectionsContainer() The container for the directions.
int	getLengthUnits() The length units.
String	getTimeAttributeName() The network attribute for time calculation.
boolean	isAutoShowDirections() Indicates if directions are automatically updated and shown when a route changes.
boolean	isDisplayTime() Indicates if time is displayed in directions.
void	setAutoShowDirections(boolean show) Indicates if directions are automatically updated and shown when a route changes.
void	setDisplayTime(boolean display) Indicates if time is displayed in directions.
void	setLengthUnits(int units) The length units.
void	setTimeAttributeName(String name) The network attribute for time calculation.

Method Detail

getLengthUnits

int getLengthUnits()
                   throws IOException,
                          AutomationException

The length units.

Remarks

LengthUnits specifies the length units of the directions in esriNetworkAttributeUnits. The currently supported length units for this property are esriNAUMiles, esriNAUKilometers, esriNAUMeters, esriNAUYards, and esriNAUFeet.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLengthUnits

void setLengthUnits(int units)
                    throws IOException,
                           AutomationException

The length units.

Product Availability

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

Parameters:

units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayTime

boolean isDisplayTime()
                      throws IOException,
                             AutomationException

Indicates if time is displayed in directions.

Remarks

DisplayTime indicates if the direction driving time should be displayed or not.

Product Availability

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

Returns:

The display

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTime

void setDisplayTime(boolean display)
                    throws IOException,
                           AutomationException

Indicates if time is displayed in directions.

Remarks

DisplayTime indicates if the direction driving time should be displayed or not.

Product Availability

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

Parameters:

display - The display (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeAttributeName

String getTimeAttributeName()
                            throws IOException,
                                   AutomationException

The network attribute for time calculation.

Remarks

TimeAttributeName specifies the name of the time cost attribute used by directions.

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.

setTimeAttributeName

void setTimeAttributeName(String name)
                          throws IOException,
                                 AutomationException

The network attribute for time calculation.

Remarks

TimeAttributeName specifies the name of the time cost attribute used by directions.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoShowDirections

boolean isAutoShowDirections()
                             throws IOException,
                                    AutomationException

Indicates if directions are automatically updated and shown when a route changes.

Remarks

AutoShowDirections indicates if the NADirectionsWindow is shown automatically after a route is solved.

Product Availability

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

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoShowDirections

void setAutoShowDirections(boolean show)
                           throws IOException,
                                  AutomationException

Indicates if directions are automatically updated and shown when a route changes.

Remarks

AutoShowDirections indicates if the NADirectionsWindow will be shown automatically after a route is solved or not.

Product Availability

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

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsContainer

INAStreetDirectionsContainer getDirectionsContainer()
                                                    throws IOException,
                                                           AutomationException

The container for the directions.

Remarks

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

void execute(ISet set,
             ITrackCancel trackCancel)
             throws IOException,
                    AutomationException

Constructs the directions.

Remarks

Execute is a method to compute the driving directions. This method takes a set containing the route features that you want to generate directions for. If null is passed in, it will generate directions for all routes. If you want to generate directions for a subset of the routes, create a new set object and add route features from the corresponding Routes or CFRoutes network analysis class.

Product Availability

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

Parameters:

set - A reference to a com.esri.arcgis.system.ISet (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.