com.esri.arcgis.networkanalyst
Interface INATraversalResultElement

All Superinterfaces:

Serializable

All Known Implementing Classes:

NATraversalResultElement

public interface INATraversalResultElement
extends Serializable

Provides access to traversal result elements.

Remarks

The INATraversalResultElement is the main interface on the NATraversalResultElement object. It provides the properties ElementID, ElementType, SourceID, SourceOID, FromPosition, and ToPosition to retrieve the corresponding information stored in the feature.

You can use the properties on this interface to retrieve the information from the row, or you can simply query the value from the row yourself after first determining the field name from the INATraversalResultQuery interface. This is what the various properties mean:

• ElementID - The ObjectID of the NATraversalResultElement.
• ElementType - The type of traversal element (esriNETJunction, esriNETEdge, or esriNETTurn).
• SourceID - The SourceID of the feature class the NATraversalResultElement is referencing. This references the SourceID of a NATraversalResultSource accessed through INATraversalResult.
• SourceOID - The ObjectID of the Feature in the NetworkDataset's or NAContext's FeatureClass.
• FromPosition - The starting position of an NATraversalResultElement on the underlying feature in the network dataset.
• ToPosition - The ending position of an NATraversalResultElement on the underlying feature in the network dataset.

Product Availability

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

Method Summary

int	getElementID() The result element ID.
int	getElementType() The result element type.
double	getFromPosition() The starting position of the result element on the result source.
int	getSourceID() The result element source ID.
int	getSourceOID() The result element source OID.
double	getToPosition() The ending position of the result element on the result source.
void	setFromPosition(double position) The starting position of the result element on the result source.
void	setSourceID(int sourceID) The result element source ID.
void	setSourceOID(int sourceOID) The result element source OID.
void	setToPosition(double position) The ending position of the result element on the result source.

Method Detail

getElementID

int getElementID()
                 throws IOException,
                        AutomationException

The result element ID.

Remarks

The ObjectID of the NATraversalResultElement.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementType

int getElementType()
                   throws IOException,
                          AutomationException

The result element type.

Remarks

The type of traversal element (esriNETJunction, esriNETEdge, or esriNETTurn).

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceID

void setSourceID(int sourceID)
                 throws IOException,
                        AutomationException

The result element source ID.

Remarks

The SourceID property specifies the SourceID of the feature class the NATraversalResultElement is referencing. This references the SourceID of an NATraversalResultSource accessed through INATraversalResult.

Product Availability

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

Parameters:

sourceID - The sourceID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceID

int getSourceID()
                throws IOException,
                       AutomationException

The result element source ID.

Remarks

The SourceID property specifies the SourceID of the feature class the NATraversalResultElement is referencing. This references the SourceID of an NATraversalResultSource accessed through INATraversalResult.

Product Availability

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

Returns:

The sourceID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceOID

void setSourceOID(int sourceOID)
                  throws IOException,
                         AutomationException

The result element source OID.

Remarks

The SourceOID property specifies the ObjectID of the Feature in the NetworkDataset's or NAContext's FeatureClass.

Product Availability

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

Parameters:

sourceOID - The sourceOID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceOID

int getSourceOID()
                 throws IOException,
                        AutomationException

The result element source OID.

Remarks

The SourceOID property specifies the ObjectID of the Feature in the NetworkDataset's or NAContext's FeatureClass.

Product Availability

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

Returns:

The sourceOID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromPosition

void setFromPosition(double position)
                     throws IOException,
                            AutomationException

The starting position of the result element on the result source.

Remarks

The FromPosition property specifies the starting position of an NATraversalResultElement on the underlying feature in the network dataset.

Product Availability

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

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromPosition

double getFromPosition()
                       throws IOException,
                              AutomationException

The starting position of the result element on the result source.

Remarks

The FromPosition property specifies the starting position of an NATraversalResultElement on the underlying feature in the network dataset.

Product Availability

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

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToPosition

void setToPosition(double position)
                   throws IOException,
                          AutomationException

The ending position of the result element on the result source.

Remarks

The ToPosition property specifies the ending position of an NATraversalResultElement on the underlying feature in the network dataset.

Product Availability

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

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToPosition

double getToPosition()
                     throws IOException,
                            AutomationException

The ending position of the result element on the result source.

Remarks

The ToPosition property specifies the ending position of an NATraversalResultElement on the underlying feature in the network dataset.

Product Availability

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

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.