com.esri.arcgis.networkanalyst
Interface INAClassLoader

All Superinterfaces:
Serializable
All Known Subinterfaces:
INAClassLoader2
All Known Implementing Classes:
NAClassLoader

public interface INAClassLoader
extends Serializable

Provides access to populate network analysis classes in preparation for analysis.

Superseded By

INAClassLoader2

Remarks

The INAClassLoader interface is used, for example, to populate stop locations from a point feature class.

Product Availability

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


Method Summary
 INAClassFieldMap getFieldMap()
          The field mapping definition.
 INALocator getLocator()
          The locator to be used.
 INAClass getNAClass()
          The network analysis class.
 void load(ICursor cursor, ITrackCancel trackCancel, int[] rowsInCursor, int[] rowsLocated)
          Populate the network analysis class.
 void setFieldMapByRef(INAClassFieldMap fieldMapping)
          The field mapping definition.
 void setLocatorByRef(INALocator loaderLocator)
          The locator to be used.
 void setNAClassByRef(INAClass classToLoadInto)
          The network analysis class.
 

Method Detail

setNAClassByRef

void setNAClassByRef(INAClass classToLoadInto)
                     throws IOException,
                            AutomationException
The network analysis class.

Remarks

The NAClass property specifies the NAClass feature class holding the network locations that will be populated when INAClassLoader::Load is called.

Product Availability

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

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

getNAClass

INAClass getNAClass()
                    throws IOException,
                           AutomationException
The network analysis class.

Remarks

The NAClass property specifies the NAClass feature class holding the network locations that will be populated when INAClassLoader::Load is called.

Product Availability

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

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

setFieldMapByRef

void setFieldMapByRef(INAClassFieldMap fieldMapping)
                      throws IOException,
                             AutomationException
The field mapping definition.

Remarks

FieldMap specifies the NAClassFieldMap that dictates what the values for the newly created NALocationFeatures will be. If there is a mapped field, the mapped field value will be used. If there is no mapped field or the mapped field value is NULL, the default value will be used.

Product Availability

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

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

getFieldMap

INAClassFieldMap getFieldMap()
                             throws IOException,
                                    AutomationException
The field mapping definition.

Remarks

FieldMap specifies the NAClassFieldMap that dictates what the values for the newly created NALocationFeatures will be. If there is a mapped field, the mapped field value will be used. If there is no mapped field or the mapped field value is NULL, the default value will be used.

Product Availability

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

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

setLocatorByRef

void setLocatorByRef(INALocator loaderLocator)
                     throws IOException,
                            AutomationException
The locator to be used.

Remarks

The Locator property specifies how network locations will be found.

Product Availability

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

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

getLocator

INALocator getLocator()
                      throws IOException,
                             AutomationException
The locator to be used.

Remarks

The Locator property specifies how network locations will be found.

Product Availability

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

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

load

void load(ICursor cursor,
          ITrackCancel trackCancel,
          int[] rowsInCursor,
          int[] rowsLocated)
          throws IOException,
                 AutomationException
Populate the network analysis class.

Remarks

Load iterates through the input cursor and populates the NAClass with NALocationFeatures with field values based on the FieldMap and Locator. It returns as output parameters the number of features in the cursor and the number of network locations that could be located.

If you know the number of rows in the input cursor and are passing a TrackCancel object that has a reference to an object that implements IStepProgressor, you should set the rowsInCursor parameter to the number of rows in the cursor. This will allow for feedback showing how many rows have been loaded out of the total number to load. For example it might say "Loading into "Stops" (120 of 230)". If you do not know how many rows are in the cursor, you should initialize the rowsInCursor variable to 0 prior to calling Load.

This method will return the error E_ABORT if the ITrackCancel object passed in to Load causes the load to cancel.

Product Availability

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

Parameters:
cursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
rowsInCursor - The rowsInCursor (in/out: use single element array)
rowsLocated - The rowsLocated (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.