com.esri.arcgis.networkanalyst
Interface IGPNALayer

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IGPNALayer2
All Known Implementing Classes:
GPNALayer, IGPNALayer2Proxy, IGPNALayerProxy

public interface IGPNALayer
extends java.io.Serializable

COM Interface 'IGPNALayer'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Provides access to properties/methods of the geoprocessing network analyst layer.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID50d92590_06f5_4aa4_bf93_1cc78d5b2b06
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 

Field Detail

IID50d92590_06f5_4aa4_bf93_1cc78d5b2b06

static final int IID50d92590_06f5_4aa4_bf93_1cc78d5b2b06
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getDENetworkDataset

IDENetworkDataset getDENetworkDataset()
                                      throws java.io.IOException,
                                             AutomationException
The network dataset data element.

Returns:
A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDENetworkDatasetByRef

void setDENetworkDatasetByRef(IDENetworkDataset dataelement)
                              throws java.io.IOException,
                                     AutomationException
The network dataset data element.

Parameters:
dataelement - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassDefinition

INAClassDefinition getClassDefinition(int index)
                                      throws java.io.IOException,
                                             AutomationException
The class definition for a sublayer.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addClassDefinition

void addClassDefinition(INAClassDefinition classDef)
                        throws java.io.IOException,
                               AutomationException
Adds class definition for sublayer.

Parameters:
classDef - A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassDefinitions

IArray getClassDefinitions()
                           throws java.io.IOException,
                                  AutomationException
The array of class definitions.

Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSearchRadiusByRef

void setSearchRadiusByRef(IGPLinearUnit ppLinearUnit)
                          throws java.io.IOException,
                                 AutomationException
The search radius used for loading points.

Parameters:
ppLinearUnit - A reference to a com.esri.arcgis.geoprocessing.IGPLinearUnit (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSearchRadius

IGPLinearUnit getSearchRadius()
                              throws java.io.IOException,
                                     AutomationException
The search radius used for loading points.

Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPLinearUnit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocatorFeatureAgentsByRef

void setLocatorFeatureAgentsByRef(IArray ppAgents)
                                  throws java.io.IOException,
                                         AutomationException
The array of locator feature agents.

Parameters:
ppAgents - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocatorFeatureAgents

IArray getLocatorFeatureAgents()
                               throws java.io.IOException,
                                      AutomationException
The array of locator feature agents.

Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFindClosestAmongAllAgents

void setFindClosestAmongAllAgents(boolean bFindClosest)
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether to search all agents when loading points.

Parameters:
bFindClosest - The bFindClosest (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFindClosestAmongAllAgents

boolean isFindClosestAmongAllAgents()
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to search all agents when loading points.

Returns:
The bFindClosest
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.