com.esri.arcgis.networkanalyst
Class INAStreetDirectionsContainerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.networkanalyst.INAStreetDirectionsContainerProxy

All Implemented Interfaces:

INAStreetDirectionsContainer, Externalizable, Serializable

public class INAStreetDirectionsContainerProxy
extends com.esri.arcgis.interop.Dispatch
implements INAStreetDirectionsContainer, Serializable

Provides access to a container for driving directions.

Remarks

The INAStreetDirectionsContainer interface 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	INAStreetDirectionsContainerProxy()
	INAStreetDirectionsContainerProxy(Object obj)
protected	INAStreetDirectionsContainerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
INAStreetDirections	getDirections(int index) The route directions by index.
int	getDirectionsCount() The number of routes for the generated directions.
void	removeListener(String iidStr, Object theListener)
void	saveAsXML(String filename) Saves the directions to a file in XML format.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

INAStreetDirectionsContainerProxy

public INAStreetDirectionsContainerProxy()

INAStreetDirectionsContainerProxy

public INAStreetDirectionsContainerProxy(Object obj)
                                  throws IOException

Throws:

IOException

INAStreetDirectionsContainerProxy

protected INAStreetDirectionsContainerProxy(Object obj,
                                            String iid)
                                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getDirectionsCount

public int getDirectionsCount()
                       throws IOException,
                              AutomationException

The number of routes for the generated directions.

Remarks

DirectionsCount returns the number of NAStreetDirections objects that were generated based on the number of routes passed in to INAStreetDirectionsAgent::Execute.

Product Availability

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

Specified by:

getDirectionsCount in interface INAStreetDirectionsContainer

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirections

public INAStreetDirections getDirections(int index)
                                  throws IOException,
                                         AutomationException

The route directions by index.

Product Availability

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

Specified by:

getDirections in interface INAStreetDirectionsContainer

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAsXML

public void saveAsXML(String filename)
               throws IOException,
                      AutomationException

Saves the directions to a file in XML format.

Remarks

SaveAsXML saves all of the directions into an XML file.

The output XML file containing directions can be converted into a properly formatted HTML file using the style sheets available in the ArcGIS installation folder. For example, the directions output in XML format can be converted into an HTML file or a Text file using the style sheet Dir2WebDocument.xsl or Dir2PlainText.xsl respectively (usually found at C:\Program Files\ArcGIS\NetworkAnalyst\Directions\Styles).

Product Availability

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

Specified by:

saveAsXML in interface INAStreetDirectionsContainer

Parameters:

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.