com.esri.arcgis.datasourcesfile
Interface ISMDirItem

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISMDirItemProxy, SMDirItem

public interface ISMDirItem
extends Serializable

Deprecated as of 10.1. 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.

Method Summary

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.

Method Detail

getText

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTime

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveText

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemType

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.

Returns:

A com.esri.arcgis.datasourcesfile.esriSMDirItemType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRoutePart

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShape

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.

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

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.

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

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.

Returns:

The pbstrStreetName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnAngle

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.

Returns:

The pdAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuth

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.

Returns:

A com.esri.arcgis.datasourcesfile.esriSMAzimuthType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.