com.esri.arcgis.networkanalyst
Interface IGPNALayer

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGPNALayer2

All Known Implementing Classes:

GPNALayer, IGPNALayer2Proxy, IGPNALayerProxy

public interface IGPNALayer
extends Serializable

Provides access to properties/methods of the geoprocessing network analyst layer.

Product Availability

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

Method Summary

void	addClassDefinition(INAClassDefinition classDef) Adds class definition for sublayer.
INAClassDefinition	getClassDefinition(int index) The class definition for a sublayer.
IArray	getClassDefinitions() The array of class definitions.
IDENetworkDataset	getDENetworkDataset() The network dataset data element.
IArray	getLocatorFeatureAgents() The array of locator feature agents.
IGPLinearUnit	getSearchRadius() The search radius used for loading points.
boolean	isFindClosestAmongAllAgents() Indicates whether to search all agents when loading points.
void	setDENetworkDatasetByRef(IDENetworkDataset dataelement) The network dataset data element.
void	setFindClosestAmongAllAgents(boolean bFindClosest) Indicates whether to search all agents when loading points.
void	setLocatorFeatureAgentsByRef(IArray ppAgents) The array of locator feature agents.
void	setSearchRadiusByRef(IGPLinearUnit ppLinearUnit) The search radius used for loading points.

Method Detail

getDENetworkDataset

IDENetworkDataset getDENetworkDataset()
                                      throws IOException,
                                             AutomationException

The network dataset data element.

Product Availability

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

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.

setDENetworkDatasetByRef

void setDENetworkDatasetByRef(IDENetworkDataset dataelement)
                              throws IOException,
                                     AutomationException

The network dataset data element.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassDefinition

INAClassDefinition getClassDefinition(int index)
                                      throws IOException,
                                             AutomationException

The class definition for a sublayer.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addClassDefinition

void addClassDefinition(INAClassDefinition classDef)
                        throws IOException,
                               AutomationException

Adds class definition for sublayer.

Product Availability

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

Parameters:

classDef - A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassDefinitions

IArray getClassDefinitions()
                           throws IOException,
                                  AutomationException

The array of class definitions.

Product Availability

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

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.

setSearchRadiusByRef

void setSearchRadiusByRef(IGPLinearUnit ppLinearUnit)
                          throws IOException,
                                 AutomationException

The search radius used for loading points.

Product Availability

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

Parameters:

ppLinearUnit - A reference to a com.esri.arcgis.geoprocessing.IGPLinearUnit (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchRadius

IGPLinearUnit getSearchRadius()
                              throws IOException,
                                     AutomationException

The search radius used for loading points.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPLinearUnit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocatorFeatureAgentsByRef

void setLocatorFeatureAgentsByRef(IArray ppAgents)
                                  throws IOException,
                                         AutomationException

The array of locator feature agents.

Product Availability

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

Parameters:

ppAgents - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocatorFeatureAgents

IArray getLocatorFeatureAgents()
                               throws IOException,
                                      AutomationException

The array of locator feature agents.

Product Availability

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

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.

setFindClosestAmongAllAgents

void setFindClosestAmongAllAgents(boolean bFindClosest)
                                  throws IOException,
                                         AutomationException

Indicates whether to search all agents when loading points.

Product Availability

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

Parameters:

bFindClosest - The bFindClosest (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFindClosestAmongAllAgents

boolean isFindClosestAmongAllAgents()
                                    throws IOException,
                                           AutomationException

Indicates whether to search all agents when loading points.

Product Availability

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

Returns:

The bFindClosest

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.