com.esri.arcgis.networkanalyst
Interface INATraversalResultSource

All Superinterfaces:

Serializable

All Known Implementing Classes:

NATraversalResultSource

public interface INATraversalResultSource
extends Serializable

Provides access to traversal results for a particular source.

Remarks

The INATraversalResultSource interface is the main interface for the NATraversalResultSource.

The NATraversalResult has 3 feature classes representing edges, junctions, and turns. The SourceID field on these feature classes references an NATraversalResultSource object's ID property. From a particular NATraversalResultSource, you can find its corresponding feature class in the NetworkDataset or NAContext by accessing either the Location or Name property on the INATraversalResultSource interface.

Product Availability

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

Method Summary

int	getElementType() The network element type.
int	getID() The result source ID.
IDatasetName	getLocation() The result source location.
String	getName() The result source name.
int	getResultSourceType() The result source type.
ITable	getTable() The result source table.
void	setElementType(int networkElementType) The network element type.
void	setLocationByRef(IDatasetName name) The result source location.
void	setName(String name) The result source name.
void	setResultSourceType(int sourceType) The result source type.

Method Detail

setElementType

void setElementType(int networkElementType)
                    throws IOException,
                           AutomationException

The network element type.

Remarks

The ElementType property specifies the type of traversal element the source represents. The valid values for the enumeration esriNetworkElementType include:

• esriNETJunction = 1
• esriNETEdge = 2
• esriNETTurn = 3

Product Availability

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

Parameters:

networkElementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementType

int getElementType()
                   throws IOException,
                          AutomationException

The network element type.

Remarks

The ElementType property specifies the type of traversal element the source represents. The valid values for the enumeration esriNetworkElementType include:

• esriNETJunction = 1
• esriNETEdge = 2
• esriNETTurn = 3

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.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The result source name.

Remarks

This is the name of the NATraversalResultSource.

If the ResultSourceType is esriNATraversalResultSourceNetworkSource, then the convention is for the Name to be the name of the source in the NetworkDataset, prefixed with 'ND_'. For example, if there is a source in the NetworkDataset named 'Streets', the NATraversalResultSource Name property would be 'ND_Streets'.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The result source name.

Remarks

This is the name of the NATraversalResultSource.

If the ResultSourceType is esriNATraversalResultSourceNetworkSource, then the convention is for the Name to be the name of the source in the NetworkDataset, prefixed with 'ND_'. For example, if there is a source in the NetworkDataset named 'Streets', the NATraversalResultSource Name property would be 'ND_Streets'.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultSourceType

void setResultSourceType(int sourceType)
                         throws IOException,
                                AutomationException

The result source type.

Remarks

The ResultSourceType property refers to the type of traversal element the source represents. The valid values for the enumeration esriNATraversalResultSourceType include:

• esriNATraversalResultSourceAnalysisClass = 0: This means the source feature class is an NAClass in the NAContext.
• esriNATraversalResultSourceNetworkSource = 1: This means the source feature class is part of an NetworkDataset.

Product Availability

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

Parameters:

sourceType - A com.esri.arcgis.networkanalyst.esriNATraversalResultSourceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultSourceType

int getResultSourceType()
                        throws IOException,
                               AutomationException

The result source type.

Remarks

The ResultSourceType property refers to the type of traversal element the source represents. The valid values for the enumeration esriNATraversalResultSourceType include:

• esriNATraversalResultSourceAnalysisClass = 0: This means the source feature class is an NAClass in the NAContext.
• esriNATraversalResultSourceNetworkSource = 1: This means the source feature class is part of an NetworkDataset.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNATraversalResultSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

int getID()
          throws IOException,
                 AutomationException

The result source ID.

Remarks

The SourceID of the NATraversalResultSource.

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.

setLocationByRef

void setLocationByRef(IDatasetName name)
                      throws IOException,
                             AutomationException

The result source location.

Remarks

The Location property holds an IDatasetName interface that references the corresponding source in the NAContext or NetworkDataset.

Product Availability

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

Parameters:

name - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocation

IDatasetName getLocation()
                         throws IOException,
                                AutomationException

The result source location.

Remarks

The Location property holds an IDatasetName interface that references the corresponding source in the NAContext or NetworkDataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IDatasetName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

ITable getTable()
                throws IOException,
                       AutomationException

The result source table.

Remarks

The Table property returns an ITable interface that references the corresponding source in the NAContext or NetworkDataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.