com.esri.arcgis.datasourcesfile
Class ISMDirectionsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesfile.ISMDirectionsProxy

All Implemented Interfaces:

ISMDirections, Externalizable, Serializable

public class ISMDirectionsProxy
extends com.esri.arcgis.interop.Dispatch
implements ISMDirections, Serializable

Provides access to the driving directions information (path geometry and description of each path segment).

Description

Provides driving directions information including path geometry and a detailed description for each path segment.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
ISMRouterEnvelope	getBoundBox() The geographic extent of the entire route.
int	getCount() The total number of items in the driving directions object.
ISMDirItem	getItem(int position) A reference to a direction item by its position.
Date	getTotalDrivingTime() The total driving time for the route.
double	getTotalLength() The total length of the route (in miles by default).
String	getTotalsText() A string containing the total time and length of the route.
Date	getTotalTime() The total time of the entire trip.
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

ISMDirectionsProxy

public ISMDirectionsProxy()

ISMDirectionsProxy

public ISMDirectionsProxy(Object obj)
                   throws IOException

Throws:

IOException

ISMDirectionsProxy

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

getTotalLength

public double getTotalLength()
                      throws IOException,
                             AutomationException

The total length of the route (in miles by default).

Description

Returns total length (in miles) of the route found.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTotalLength in interface ISMDirections

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalTime

public Date getTotalTime()
                  throws IOException,
                         AutomationException

The total time of the entire trip.

Description

Returns total time of the trip.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTotalTime in interface ISMDirections

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalDrivingTime

public Date getTotalDrivingTime()
                         throws IOException,
                                AutomationException

The total driving time for the route.

Description

Returns the total driving time for the route.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTotalDrivingTime in interface ISMDirections

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalsText

public String getTotalsText()
                     throws IOException,
                            AutomationException

A string containing the total time and length of the route.

Description

Returns text string consisting of the total time and length of the route.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTotalsText in interface ISMDirections

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundBox

public ISMRouterEnvelope getBoundBox()
                              throws IOException,
                                     AutomationException

The geographic extent of the entire route.

Description

Returns the geographic extent of the entire route path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBoundBox in interface ISMDirections

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMRouterEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The total number of items in the driving directions object.

Description

Returns the number of items in the driving direction object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface ISMDirections

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

public ISMDirItem getItem(int position)
                   throws IOException,
                          AutomationException

A reference to a direction item by its position.

Product Availability

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

Specified by:

getItem in interface ISMDirections

Parameters:

position - The position (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMDirItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.