com.esri.arcgis.networkanalyst
Interface INAServerRecordSet

All Superinterfaces:
INAServerLocations, Serializable
All Known Implementing Classes:
NAServerRecordSet

public interface INAServerRecordSet
extends INAServerLocations, Serializable

Provides access to a RecordSet containing network locations.

Remarks

The INAServerRecordSet interface provides access to a RecordSet object representing network locations.

The NAServerRecordSet object that implements this interface can be passed in to any of the properties of the NAServerSolverParams objects that expect an INAServerLocations interface pointer. For example, Stops, Barriers, Facilities, or Incidents.

At a minimum, the RecordSet needs a shape field with a point geometry type. You can also add additional fields that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (long), "SourceOID" (long), "PosAlong" (double), and "SideOfEdge" (long) the values in these fields will specify the network location rather than performing a spatial search to determine the network location.

Any other fields can be added to the RecordSet and may be used when loading network locations. What fields map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps .

Product Availability

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


Method Summary
 IRecordSet getRecordSet()
          The recordset.
 void setRecordSetByRef(IRecordSet ppValue)
          The recordset.
 

Method Detail

getRecordSet

IRecordSet getRecordSet()
                        throws IOException,
                               AutomationException
The recordset.

Remarks

The RecordSet property provides access to a RecordSet of network locations.

At a minimum, the RecordSet needs a shape field with a point geometry type. You can also add additional fields that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (long), "SourceOID" (long), "PosAlong" (double), and "SideOfEdge" (long) the values in these fields will specify the network location rather than performing a spatial search to determine the network location.

Any other fields can be added to the RecordSet and may be used when loading network locations. What fields map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps .

Product Availability

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

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

setRecordSetByRef

void setRecordSetByRef(IRecordSet ppValue)
                       throws IOException,
                              AutomationException
The recordset.

Remarks

The RecordSet property provides access to a RecordSet of network locations.

At a minimum, the RecordSet needs a shape field with a point geometry type. You can also add additional fields that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (long), "SourceOID" (long), "PosAlong" (double), and "SideOfEdge" (long) the values in these fields will specify the network location rather than performing a spatial search to determine the network location.

Any other fields can be added to the RecordSet and may be used when loading network locations. What fields map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps .

Product Availability

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

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