com.esri.arcgis.networkanalyst
Interface IGPNAUtilities

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPNAUtilities

public interface IGPNAUtilities
extends Serializable

Provides access to network analyst geoprocessing utilities.

Product Availability

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

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.
IArray	getLocatorFeatureAgents(IDENetworkDataset de, boolean bIncludeSubtypes) Get an array of locator feature agents for a network dataset.

Method Detail

decodeDENetwork

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.

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

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.

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

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.

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

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.

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.