com.esri.arcgis.arcweb
Interface IArcWebRouteInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebRouteInfo, IArcWebRouteInfoProxy

public interface IArcWebRouteInfo
extends Serializable

Provides access to members that contain information about an ArcWebRoute.

Product Availability

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

Method Summary

String	getDescriptiveDistance() A description of the length of the route.
String	getDescriptiveTime() A description of the estimated time the route takes to drive.
IEnumArcWebDirections	getDirections() An enumeration of the ArcWebDirections.
double	getDistance() The total length of the route.
int	getDistanceUnits() The units of the route distance.
IEnvelope	getExtent() The extent of the route.
IPicture	getImage() The picture of the route.
IPolyline	getPath() The geometry of the route.
double	getTime() The estimated number of minutes the route takes to drive.
IEnumArcWebTurnByTurnMaps	getTurnByTurnMaps() An enumeration of the ArcWebTurnByTurnMaps.

Method Detail

getPath

IPolyline getPath()
                  throws IOException,
                         AutomationException

The geometry of the route.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IPolyline

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirections

IEnumArcWebDirections getDirections()
                                    throws IOException,
                                           AutomationException

An enumeration of the ArcWebDirections.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnByTurnMaps

IEnumArcWebTurnByTurnMaps getTurnByTurnMaps()
                                            throws IOException,
                                                   AutomationException

An enumeration of the ArcWebTurnByTurnMaps.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebTurnByTurnMaps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImage

IPicture getImage()
                  throws IOException,
                         AutomationException

The picture of the route.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IPicture

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceUnits

int getDistanceUnits()
                     throws IOException,
                            AutomationException

The units of the route distance.

Product Availability

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

Returns:

A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistance

double getDistance()
                   throws IOException,
                          AutomationException

The total length of the route.

Product Availability

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

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTime

double getTime()
               throws IOException,
                      AutomationException

The estimated number of minutes the route takes to drive.

Product Availability

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

Returns:

The time

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the route.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescriptiveDistance

String getDescriptiveDistance()
                              throws IOException,
                                     AutomationException

A description of the length of the route.

Product Availability

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

Returns:

The descriptiveDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescriptiveTime

String getDescriptiveTime()
                          throws IOException,
                                 AutomationException

A description of the estimated time the route takes to drive.

Product Availability

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

Returns:

The descriptiveTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.