com.esri.arcgis.networkanalyst
Interface INACompactStreetDirectionsAgent

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
INACompactStreetDirectionsAgent2
All Known Implementing Classes:
INACompactStreetDirectionsAgent2Proxy, INACompactStreetDirectionsAgentProxy, NACompactStreetDirectionsAgent

public interface INACompactStreetDirectionsAgent
extends java.io.Serializable

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

Description: 'Provides access to the compact 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 IIDfd2adb84_43c1_48e6_910e_8e2c7ebe63a9
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void execute(ISet set, ITrackCancel trackCancel)
          Constructs the directions.
 INACompactStreetDirectionsContainer getDirectionsContainer()
          The container for the directions.
 java.lang.String getLanguage()
          Language to use when generating directions.
 int getLengthUnits()
          The length units.
 java.lang.String getTimeAttributeName()
          The network attribute for time calculation.
 void setLanguage(java.lang.String strLanguage)
          Language to use when generating directions.
 void setLengthUnits(int units)
          The length units.
 void setTimeAttributeName(java.lang.String name)
          The network attribute for time calculation.
 

Field Detail

IIDfd2adb84_43c1_48e6_910e_8e2c7ebe63a9

static final int IIDfd2adb84_43c1_48e6_910e_8e2c7ebe63a9
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.

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.

getLanguage

java.lang.String getLanguage()
                             throws java.io.IOException,
                                    AutomationException
Language to use when generating directions.

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

setLanguage

void setLanguage(java.lang.String strLanguage)
                 throws java.io.IOException,
                        AutomationException
Language to use when generating directions.

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

getDirectionsContainer

INACompactStreetDirectionsContainer getDirectionsContainer()
                                                           throws java.io.IOException,
                                                                  AutomationException
The container for the directions.

Returns:
A reference to a com.esri.arcgis.networkanalyst.INACompactStreetDirectionsContainer
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.