com.esri.arcgis.networkanalyst
Interface INAStreetDirectionsAgent

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

INAStreetDirectionsAgent2, INAStreetDirectionsAgent3

All Known Implementing Classes:

INAStreetDirectionsAgent2Proxy, INAStreetDirectionsAgent3Proxy, INAStreetDirectionsAgentProxy, NAStreetDirectionsAgent

public interface INAStreetDirectionsAgent
extends java.io.Serializable

COM Interface 'INAStreetDirectionsAgent'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Provides access to the Directions Agent.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID67b62ed9_2ebb_488b_ae93_13c137ba4a84
static int	xxDummy Deprecated. Internal use only

Method Summary

void	execute(ISet set, ITrackCancel trackCancel) Constructs the directions.
INAStreetDirectionsContainer	getDirectionsContainer() The container for the directions.
int	getLengthUnits() The length units.
java.lang.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(java.lang.String name) The network attribute for time calculation.

Field Detail

IID67b62ed9_2ebb_488b_ae93_13c137ba4a84

static final int IID67b62ed9_2ebb_488b_ae93_13c137ba4a84

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getLengthUnits

int getLengthUnits()
                   throws java.io.IOException,
                          AutomationException

The length units.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLengthUnits

void setLengthUnits(int units)
                    throws java.io.IOException,
                           AutomationException

The length units.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayTime

boolean isDisplayTime()
                      throws java.io.IOException,
                             AutomationException

Indicates if time is displayed in directions.

Returns:

The display

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTime

void setDisplayTime(boolean display)
                    throws java.io.IOException,
                           AutomationException

Indicates if time is displayed in directions.

Parameters:

display - The display (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeAttributeName

java.lang.String getTimeAttributeName()
                                      throws java.io.IOException,
                                             AutomationException

The network attribute for time calculation.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeAttributeName

void setTimeAttributeName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The network attribute for time calculation.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoShowDirections

boolean isAutoShowDirections()
                             throws java.io.IOException,
                                    AutomationException

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

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoShowDirections

void setAutoShowDirections(boolean show)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsContainer

INAStreetDirectionsContainer getDirectionsContainer()
                                                    throws java.io.IOException,
                                                           AutomationException

The container for the directions.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

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

Constructs the directions.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.