com.esri.arcgis.networkanalyst
Class GPNAUtilities

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IGPNAUtilities, Serializable

public class GPNAUtilities
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPNAUtilities

Network analyst geoprocessing utilities.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPNAUtilities()
Constructs a GPNAUtilities using ArcGIS Engine.

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

Method Summary

IDENetworkDataset	decodeDENetwork(IGPValue value) Returns the network dataset data element specified by the given geoprocessing value object.
IGPNALayer	decodeGPNALayer(IGPValue value) Returns the network analyst layer data element specified by the given geoprocessing value object.
INALayer	decodeNALayer(IGPValue value) Returns the network analyst layer specified by the given geoprocessing value object.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IArray	getLocatorFeatureAgents(IDENetworkDataset de, boolean bIncludeSubtypes) Get an array of locator feature agents for a network dataset.
int	hashCode() the hashcode for this object

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

GPNAUtilities

public GPNAUtilities()
              throws IOException,
                     UnknownHostException

Constructs a GPNAUtilities using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPNAUtilities

public GPNAUtilities(Object obj)
              throws IOException

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

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

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

decodeDENetwork

public IDENetworkDataset decodeDENetwork(IGPValue value)
                                  throws IOException,
                                         AutomationException

Returns the network dataset data element specified by the given geoprocessing value object.

Remarks

DecodeDENetwork takes in a GPValue and queries a DENetworkDataset from it.

Product Availability

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

Specified by:

decodeDENetwork in interface IGPNAUtilities

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeNALayer

public INALayer decodeNALayer(IGPValue value)
                       throws IOException,
                              AutomationException

Returns the network analyst layer specified by the given geoprocessing value object.

Remarks

DecodeGPNALayer takes in a GPValue and queries a GPNALayer from it.

Product Availability

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

Specified by:

decodeNALayer in interface IGPNAUtilities

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeGPNALayer

public IGPNALayer decodeGPNALayer(IGPValue value)
                           throws IOException,
                                  AutomationException

Returns the network analyst layer data element specified by the given geoprocessing value object.

Remarks

DecodeNALayer takes in a GPValue and queries for an NALayer from the internal list of layers.

Product Availability

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

Specified by:

decodeGPNALayer in interface IGPNAUtilities

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocatorFeatureAgents

public IArray getLocatorFeatureAgents(IDENetworkDataset de,
                                      boolean bIncludeSubtypes)
                               throws IOException,
                                      AutomationException

Get an array of locator feature agents for a network dataset.

Remarks

GetLocatorFeatureAgents takes in a DENetworkDataset and a boolean to include sub types and returns an array of locator feature agents.

Product Availability

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

Specified by:

getLocatorFeatureAgents in interface IGPNAUtilities

Parameters:

de - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

bIncludeSubtypes - The bIncludeSubtypes (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.