com.esri.arcgis.datasourcesfile
Class SMDirections

java.lang.Object
  extended by com.esri.arcgis.datasourcesfile.SMDirections
All Implemented Interfaces:
ISMDirections, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SMDirections
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISMDirections

Driving directions information including path geometry and description of each path segment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
SMDirections(Object obj)
          Construct a SMDirections using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 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.
 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

SMDirections

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

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

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

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.