com.esri.arcgis.datasourcesfile
Class ISMDirItemProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.datasourcesfile.ISMDirItemProxy
All Implemented Interfaces:
ISMDirItem, Externalizable, Serializable

public class ISMDirItemProxy
extends com.esri.arcgis.interop.Dispatch
implements ISMDirItem, Serializable

Provides access to the description and geography of one item of driving directions.

Description

Provides information about one item in the driving directions collection.

Remarks

The ISMDirItem interface provides detailed information about one item in the driving directions collection. This is the place the route path geography can be retrieved.

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ISMDirItemProxy()
           
  ISMDirItemProxy(Object obj)
           
protected ISMDirItemProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int getAzimuth()
          The azimuth of the direction item.
 ISMRouterEnvelope getBoundBox()
          The geographic extent of the direction item.
 String getDriveText()
          Formatted text descrbing the length and time of the direction item.
 int getItemType()
          The type of direction item.
 double getLength()
          The length of the route part, in miles by default, corresponding to the direction item.
 int getRoutePart()
          The route part number associated with a direction item.
 ISMPointsCollection getShape()
          A collection of points representing the shape of the direction item.
 String getStreetName()
          The street name of the direction item.
 String getText()
          A string describing the direction item.
 double getTime()
          The driving time of the route part corresponding to the direction item.
 double getTurnAngle()
          The turn angle of the direction item.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ISMDirItemProxy

public ISMDirItemProxy()

ISMDirItemProxy

public ISMDirItemProxy(Object obj)
                throws IOException
Throws:
IOException

ISMDirItemProxy

protected ISMDirItemProxy(Object obj,
                          String iid)
                   throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getText

public String getText()
               throws IOException,
                      AutomationException
A string describing the direction item.

Description

Provides a description of the item.

Product Availability

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

Specified by:
getText in interface ISMDirItem
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLength

public double getLength()
                 throws IOException,
                        AutomationException
The length of the route part, in miles by default, corresponding to the direction item.

Description

Returns length (in miles) of the route part that the item describes.

Product Availability

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

Specified by:
getLength in interface ISMDirItem
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTime

public double getTime()
               throws IOException,
                      AutomationException
The driving time of the route part corresponding to the direction item.

Description

Returns the driving time for the item.

Product Availability

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

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

getDriveText

public String getDriveText()
                    throws IOException,
                           AutomationException
Formatted text descrbing the length and time of the direction item.

Description

Returns formatted text composed from the item length and time. For example, "drive 10 mi ~ 10 minutes".

Product Availability

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

Specified by:
getDriveText in interface ISMDirItem
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemType

public int getItemType()
                throws IOException,
                       AutomationException
The type of direction item. Returns an esriSMDirItemType constant.

Description

Returns type of the driving directions item. One of esriSMDirItemType constants.

Remarks

Item type can have one value from the esriSMDirItemType enumeraiton. See esriSMDirItemType for more details.

Product Availability

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

Specified by:
getItemType in interface ISMDirItem
Returns:
A com.esri.arcgis.datasourcesfile.esriSMDirItemType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRoutePart

public int getRoutePart()
                 throws IOException,
                        AutomationException
The route part number associated with a direction item.

Description

Route part is an ordinal associated with a direction item. It equals the ordinal number of the stop with which the current segment begins.

Product Availability

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

Specified by:
getRoutePart in interface ISMDirItem
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShape

public ISMPointsCollection getShape()
                             throws IOException,
                                    AutomationException
A collection of points representing the shape of the direction item.

Description

Returns a collection of points that represent the item shape.

Remarks

Each direction item contains its shape. If you need the whole route path shape, then you need to append shapes from all items.

Product Availability

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

Specified by:
getShape in interface ISMDirItem
Returns:
A reference to a com.esri.arcgis.datasourcesfile.ISMPointsCollection
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 direction item.

Description

Returns the geographic extent of the directions item.

Product Availability

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

Specified by:
getBoundBox in interface ISMDirItem
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.

getStreetName

public String getStreetName()
                     throws IOException,
                            AutomationException
The street name of the direction item.

Description

Provides a street name to the corresponding item.

Product Availability

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

Specified by:
getStreetName in interface ISMDirItem
Returns:
The pbstrStreetName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTurnAngle

public double getTurnAngle()
                    throws IOException,
                           AutomationException
The turn angle of the direction item.

Description

Provides an angle of the directions item.

Product Availability

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

Specified by:
getTurnAngle in interface ISMDirItem
Returns:
The pdAngle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAzimuth

public int getAzimuth()
               throws IOException,
                      AutomationException
The azimuth of the direction item. Returns an esriSMAzimuthType constant.

Description

Provides the azimuth of the directions item.

Product Availability

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

Specified by:
getAzimuth in interface ISMDirItem
Returns:
A com.esri.arcgis.datasourcesfile.esriSMAzimuthType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException