com.esri.arcgis.arcweb
Class ArcWebRouteInfo

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebRouteInfo

All Implemented Interfaces:

IArcWebRouteInfo, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebRouteInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebRouteInfo

The information describing a route.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebRouteInfo(Object obj)
Construct a ArcWebRouteInfo using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
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.
int	hashCode() the hashcode for this object

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcWebRouteInfo

public ArcWebRouteInfo(Object obj)
                throws IOException

Construct a ArcWebRouteInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebRouteInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ArcWebRouteInfo o = (ArcWebRouteInfo)obj; // will not work

ArcWebRouteInfo o = new ArcWebRouteInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ArcWebRouteInfo theArcWebRouteInfo = (ArcWebRouteInfo) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getPath

public IPolyline getPath()
                  throws IOException,
                         AutomationException

The geometry of the route.

Product Availability

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

Specified by:

getPath in interface IArcWebRouteInfo

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

public IEnumArcWebDirections getDirections()
                                    throws IOException,
                                           AutomationException

An enumeration of the ArcWebDirections.

Product Availability

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

Specified by:

getDirections in interface IArcWebRouteInfo

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

public IEnumArcWebTurnByTurnMaps getTurnByTurnMaps()
                                            throws IOException,
                                                   AutomationException

An enumeration of the ArcWebTurnByTurnMaps.

Product Availability

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

Specified by:

getTurnByTurnMaps in interface IArcWebRouteInfo

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

public IPicture getImage()
                  throws IOException,
                         AutomationException

The picture of the route.

Product Availability

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

Specified by:

getImage in interface IArcWebRouteInfo

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

public int getDistanceUnits()
                     throws IOException,
                            AutomationException

The units of the route distance.

Product Availability

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

Specified by:

getDistanceUnits in interface IArcWebRouteInfo

Returns:

A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistance

public double getDistance()
                   throws IOException,
                          AutomationException

The total length of the route.

Product Availability

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

Specified by:

getDistance in interface IArcWebRouteInfo

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTime

public 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.

Specified by:

getTime in interface IArcWebRouteInfo

Returns:

The time

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the route.

Product Availability

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

Specified by:

getExtent in interface IArcWebRouteInfo

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

public String getDescriptiveDistance()
                              throws IOException,
                                     AutomationException

A description of the length of the route.

Product Availability

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

Specified by:

getDescriptiveDistance in interface IArcWebRouteInfo

Returns:

The descriptiveDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescriptiveTime

public 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.

Specified by:

getDescriptiveTime in interface IArcWebRouteInfo

Returns:

The descriptiveTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.