com.esri.arcgis.networkanalyst
Interface INAStreetDirectionsAgent3

All Superinterfaces:

INAStreetDirectionsAgent, INAStreetDirectionsAgent2, Serializable

All Known Implementing Classes:

NAStreetDirectionsAgent

public interface INAStreetDirectionsAgent3
extends INAStreetDirectionsAgent2, Serializable

Provides access to the INAStreetDirectionsAgent3 Interface.

Product Availability

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

Method Summary

IStringArray	getAvailableStyleNames() The collection of style names supported by the agent.
ISpatialReference	getOutputSpatialReference() Output spatial reference to use for geometries returned by the directions objects.
int	getOutputType() Output type to use when generating directions.
String	getStyleName() Style name to use when generating directions.
IStringArray	getSupportedLanguages() The collection of languages supported by the agent.
void	setOutputSpatialReferenceByRef(ISpatialReference ppSpatialReference) Output spatial reference to use for geometries returned by the directions objects.
void	setOutputType(int pOutputType) Output type to use when generating directions.
void	setStyleName(String pStyleName) Style name to use when generating directions.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAStreetDirectionsAgent2

getLanguage, setLanguage

Methods inherited from interface com.esri.arcgis.networkanalyst.INAStreetDirectionsAgent

execute, getDirectionsContainer, getLengthUnits, getTimeAttributeName, isAutoShowDirections, isDisplayTime, setAutoShowDirections, setDisplayTime, setLengthUnits, setTimeAttributeName

Method Detail

getOutputSpatialReference

ISpatialReference getOutputSpatialReference()
                                            throws IOException,
                                                   AutomationException

Output spatial reference to use for geometries returned by the directions objects.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

void setOutputSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                                    throws IOException,
                                           AutomationException

Output spatial reference to use for geometries returned by the directions objects.

Product Availability

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

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedLanguages

IStringArray getSupportedLanguages()
                                   throws IOException,
                                          AutomationException

The collection of languages supported by the agent.

Remarks

Returns a string array of the supported languages for which this directions agent has been localized. The configuration files associated with street directions can be found in <install directory>\NetworkAnalyst\Directions.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAvailableStyleNames

IStringArray getAvailableStyleNames()
                                    throws IOException,
                                           AutomationException

The collection of style names supported by the agent.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleName

String getStyleName()
                    throws IOException,
                           AutomationException

Style name to use when generating directions.

Product Availability

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

Returns:

The pStyleName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyleName

void setStyleName(String pStyleName)
                  throws IOException,
                         AutomationException

Style name to use when generating directions.

Product Availability

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

Parameters:

pStyleName - The pStyleName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputType

int getOutputType()
                  throws IOException,
                         AutomationException

Output type to use when generating directions.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputType

void setOutputType(int pOutputType)
                   throws IOException,
                          AutomationException

Output type to use when generating directions.

Product Availability

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

Parameters:

pOutputType - A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.