com.esri.arcgis.networkanalyst
Interface INAStreetDirection

All Superinterfaces:

Serializable

All Known Subinterfaces:

INAStreetDirection2, INAStreetDirection3

All Known Implementing Classes:

INAStreetDirection2Proxy, INAStreetDirection3Proxy, INAStreetDirectionProxy

public interface INAStreetDirection
extends Serializable

Provides access to a street direction item.

Superseded By

INAStreetDirection2

Remarks

INAStreetDirection has been superseded by INAStreetDirection3.

Product Availability

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

Method Summary

double	getDriveTime() The driving time.
IEnvelope	getEnvelope() The bounding box of the item.
double	getLength() The driving Length (in directions length units).
IPoint	getManeuverPoint() The maneuver point of the item.
INATraversalResultElement	getResultElement(int index) The result object by index.
int	getResultObjectCount() The number of result objects that belong to this direction.
String	getString(int index) The direction string by its index.
int	getStringCount() The count of direction strings in this item.
int	getStringType(int index) The direction string type by its index.
double	getTime() The time spent.

Method Detail

getStringCount

int getStringCount()
                   throws IOException,
                          AutomationException

The count of direction strings in this item.

Remarks

StringCount returns the number of direction strings.

A direction item can be made up of multiple strings of the types delineated by esriDirectionsStringType. You can access an item's strings by using StringCount to loop over String.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getString

String getString(int index)
                 throws IOException,
                        AutomationException

The direction string by its index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The directionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringType

int getStringType(int index)
                  throws IOException,
                         AutomationException

The direction string type by its index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.networkanalyst.esriDirectionsStringType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength

double getLength()
                 throws IOException,
                        AutomationException

The driving Length (in directions length units).

Remarks

Length returns the length of the particular direction element.

Product Availability

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

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTime

double getTime()
               throws IOException,
                      AutomationException

The time spent.

Remarks

Time returns the travel time of the particular direction element.

Product Availability

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

Returns:

The time

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveTime

double getDriveTime()
                    throws IOException,
                           AutomationException

The driving time.

Remarks

DriveTime returns the driving time of the particular direction element.

Product Availability

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

Returns:

The time

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvelope

IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException

The bounding box of the item.

Remarks

Envelope returns the geographic envelope of the direction.

Product Availability

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

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.

getManeuverPoint

IPoint getManeuverPoint()
                        throws IOException,
                               AutomationException

The maneuver point of the item.

Remarks

ManeuverPoint returns the point of the turn of the direction.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultObjectCount

int getResultObjectCount()
                         throws IOException,
                                AutomationException

The number of result objects that belong to this direction.

Remarks

ResultObjectCount returns the number of traversal result elements associated with the direction element.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultElement

INATraversalResultElement getResultElement(int index)
                                           throws IOException,
                                                  AutomationException

The result object by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.networkanalyst.INATraversalResultElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.