com.esri.arcgis.arcweb
Class ArcWebDirections

java.lang.Object
  extended by com.esri.arcgis.arcweb.ArcWebDirections
All Implemented Interfaces:
IArcWebDirections, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebDirections
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebDirections

The segments descriptions of a route.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ArcWebDirections(Object obj)
          Construct a ArcWebDirections 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 getDescriptiveDirections()
          A description of the route segment.
 String getDescriptiveDistance()
          A descriptive distance of the route segment.
 double getDistance()
          The distance of the route segment.
 IEnvelope getExtent()
          The extent of the route segment.
 double getTime()
          The estimated number of minutes the route segment takes to drive.
 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

ArcWebDirections

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

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

Throws:
IOException - if there are interop problems ArcWebDirections theArcWebDirections = (ArcWebDirections) 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

getDescriptiveDirections

public String getDescriptiveDirections()
                                throws IOException,
                                       AutomationException
A description of the route segment.

Product Availability

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

Specified by:
getDescriptiveDirections in interface IArcWebDirections
Returns:
The descriptiveDirections
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescriptiveDistance

public String getDescriptiveDistance()
                              throws IOException,
                                     AutomationException
A descriptive distance of the route segment.

Product Availability

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

Specified by:
getDescriptiveDistance in interface IArcWebDirections
Returns:
The descriptiveDistance
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 segment.

Product Availability

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

Specified by:
getExtent in interface IArcWebDirections
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.

getDistance

public double getDistance()
                   throws IOException,
                          AutomationException
The distance of the route segment.

Product Availability

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

Specified by:
getDistance in interface IArcWebDirections
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 segment takes to drive.

Product Availability

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

Specified by:
getTime in interface IArcWebDirections
Returns:
The time
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.