com.esri.arcgis.networkanalyst
Class INACompactStreetDirectionsProxy

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

All Implemented Interfaces:

INACompactStreetDirections, Externalizable, Serializable

public class INACompactStreetDirectionsProxy
extends com.esri.arcgis.interop.Dispatch
implements INACompactStreetDirections, Serializable

Provides access to compact driving directions.

Remarks

The INACompactStreetDirections interface provides access to the NACompactStreetDirections 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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
INACompactStreetDirection	getDirection(int index) The direction by index.
int	getDirectionCount() The directions count.
int	getRouteID() The route ID for the directions.
String	getRouteName() The route name for the directions.
INACompactStreetDirectionSummary	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

INACompactStreetDirectionsProxy

public INACompactStreetDirectionsProxy()

INACompactStreetDirectionsProxy

public INACompactStreetDirectionsProxy(Object obj)
                                throws IOException

Throws:

IOException

INACompactStreetDirectionsProxy

protected INACompactStreetDirectionsProxy(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 ObjectID of the corresponding route feature in the Routes or CFRoutes network analysis class.

Product Availability

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

Specified by:

getRouteID in interface INACompactStreetDirections

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. This is retrieved from the name field of the corresponding route feature in the Routes or CFRoutes network analysis class.

Product Availability

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

Specified by:

getRouteName in interface INACompactStreetDirections

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 directions count.

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 INACompactStreetDirections

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

public INACompactStreetDirection getDirection(int index)
                                       throws IOException,
                                              AutomationException

The direction by index.

Product Availability

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

Specified by:

getDirection in interface INACompactStreetDirections

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSummary

public INACompactStreetDirectionSummary getSummary()
                                            throws IOException,
                                                   AutomationException

The summary information.

Remarks

Summary gives access to INACompactStreetDirectionSummary 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 INACompactStreetDirections

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.