com.esri.arcgis.datasourcesfile
Interface ISMDirections

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISMDirectionsProxy, SMDirections

public interface ISMDirections
extends 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.

Method Summary

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.

Method Detail

getTotalLength

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalTime

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalDrivingTime

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalsText

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundBox

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

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

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

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.

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.