com.esri.arcgis.networkanalyst
Class NATraversalResultSource

java.lang.Object
  com.esri.arcgis.networkanalyst.NATraversalResultSource

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INATraversalResultSource, IPersist, IPersistStream, Externalizable, Serializable

public class NATraversalResultSource
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INATraversalResultSource, IPersistStream, Externalizable

Traversal results for a particular source.

Remarks

The NATraversalResultSource object holds the mapping to determine the feature class that a particular NATraversalResultElement is referencing based on its SourceID property.

The NATraversalResult has three 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.

See Also:

Serialized Form

Constructor Summary

NATraversalResultSource()
Constructs a NATraversalResultSource using ArcGIS Engine.

NATraversalResultSource(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NATraversalResultSource theNATraversalResultSource = (NATraversalResultSource) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITable	getTable() The result source table.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NATraversalResultSource

public NATraversalResultSource()
                        throws IOException,
                               UnknownHostException

Constructs a NATraversalResultSource using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NATraversalResultSource

public NATraversalResultSource(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NATraversalResultSource theNATraversalResultSource = (NATraversalResultSource) obj;

Construct a NATraversalResultSource using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NATraversalResultSource.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setElementType

public 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.

Specified by:

setElementType in interface INATraversalResultSource

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

public 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.

Specified by:

getElementType in interface INATraversalResultSource

Returns:

A com.esri.arcgis.geodatabase.esriNetworkElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public 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.

Specified by:

setName in interface INATraversalResultSource

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public 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.

Specified by:

getName in interface INATraversalResultSource

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultSourceType

public 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.

Specified by:

setResultSourceType in interface INATraversalResultSource

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

public 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.

Specified by:

getResultSourceType in interface INATraversalResultSource

Returns:

A com.esri.arcgis.networkanalyst.esriNATraversalResultSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public 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.

Specified by:

getID in interface INATraversalResultSource

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

public 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.

Specified by:

setLocationByRef in interface INATraversalResultSource

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

public 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.

Specified by:

getLocation in interface INATraversalResultSource

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

public 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.

Specified by:

getTable in interface INATraversalResultSource

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException