com.esri.arcgis.networkanalyst
Class INAStreetDirectionsProxy

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

All Implemented Interfaces:

INAStreetDirections, Externalizable, Serializable

public class INAStreetDirectionsProxy
extends com.esri.arcgis.interop.Dispatch
implements INAStreetDirections, Serializable

Provides access to the driving directions.

Remarks

The INAStreetDirections interface provides access to the NAStreetDirections object which holds street directions for a particular route.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
INAStreetDirection	getDirection(int index) The direction item by index.
int	getDirectionCount() The number of direction items.
int	getRouteID() The route ID for the directions.
String	getRouteName() The route name for the directions.
INAStreetDirection	getSummary() The summary information.
void	removeListener(String iidStr, Object theListener)

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

INAStreetDirectionsProxy

public INAStreetDirectionsProxy()

INAStreetDirectionsProxy

public INAStreetDirectionsProxy(Object obj)
                         throws IOException

Throws:

IOException

INAStreetDirectionsProxy

protected INAStreetDirectionsProxy(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

getRouteID

public int getRouteID()
               throws IOException,
                      AutomationException

The route ID for the directions.

Remarks

RouteID returns the ID of the route.

Product Availability

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

Specified by:

getRouteID in interface INAStreetDirections

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteName

public String getRouteName()
                    throws IOException,
                           AutomationException

The route name for the directions.

Remarks

RouteName returns the name of the route.

Product Availability

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

Specified by:

getRouteName in interface INAStreetDirections

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionCount

public int getDirectionCount()
                      throws IOException,
                             AutomationException

The number of direction items.

Remarks

DirectionsCount returns the number of individual step-by-step directions associated with the route.

Product Availability

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

Specified by:

getDirectionCount in interface INAStreetDirections

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

public INAStreetDirection getDirection(int index)
                                throws IOException,
                                       AutomationException

The direction item by index.

Product Availability

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

Specified by:

getDirection in interface INAStreetDirections

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSummary

public INAStreetDirection getSummary()
                              throws IOException,
                                     AutomationException

The summary information.

Remarks

Summary gives access to INAStreetDirection which provides a summary of the route (e.g. total distance).

Product Availability

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

Specified by:

getSummary in interface INAStreetDirections

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.