com.esri.arcgis.networkanalyst
Interface INAServerODCostMatrixResults

All Superinterfaces:

INAServerSolverResults, Serializable

All Known Implementing Classes:

NAServerODCostMatrixResults

public interface INAServerODCostMatrixResults
extends INAServerSolverResults, Serializable

Provides access to properties that contain the results of performing OD Cost Matrix network analysis with NAServer.

Remarks

INAServerODCostMatrixResults provides methods on an NAServerODCostMatrixResults object returned by the Solve method on INAServer to retrieve the results of the network analysis.

Product Availability

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

Method Summary

IRecordSet	getBarriers() RecordSet of Barriers returned from the network analysis.
String[]	getCostAttributeNameIndex() Array of mappings of the cost attribute names into ODMatrix array index values.
int[]	getDestinationOIDIndex() Array of mappings of the Destination OIDs into ODMatrix array index values.
IRecordSet	getDestinations() RecordSet of Destinations returned from the network analysis.
IRecordSet	getODLines() RecordSet of ODRoutes returned from the network analysis.
Object	getODMatrix() 3D array [origin, destination, cost] of OD-values returned from the network analysis.
int[]	getOriginOIDIndex() Array of mappings of the Origin OIDs into ODMatrix array index values.
IRecordSet	getOrigins() RecordSet of Origins returned from the network analysis.
IRecordSet	getPolygonBarriers() RecordSet of Polygon Barriers returned from the network analysis.
IRecordSet	getPolylineBarriers() RecordSet of Polyline Barriers returned from the network analysis.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverResults

getMapImage, getSolveMessages

Method Detail

getODLines

IRecordSet getODLines()
                      throws IOException,
                             AutomationException

RecordSet of ODRoutes returned from the network analysis.

Remarks

ODLines contains the output line features between origins and destinations returned from the analysis.

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.

getOrigins

IRecordSet getOrigins()
                      throws IOException,
                             AutomationException

RecordSet of Origins returned from the network analysis.

Remarks

Origins returns an IRecordSet that holds the origins used during analysis.

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.

getDestinations

IRecordSet getDestinations()
                           throws IOException,
                                  AutomationException

RecordSet of Destinations returned from the network analysis.

Remarks

Destinations returns an IRecordSet that holds the destinations used during analysis.

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.

getBarriers

IRecordSet getBarriers()
                       throws IOException,
                              AutomationException

RecordSet of Barriers returned from the network analysis.

Remarks

Barriers returns an IRecordSet that holds the barriers used during analysis.

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.

getPolylineBarriers

IRecordSet getPolylineBarriers()
                               throws IOException,
                                      AutomationException

RecordSet of Polyline Barriers returned from the network analysis.

Remarks

PolylineBarriers contains the polyline barriers used in the analysis.

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.

getPolygonBarriers

IRecordSet getPolygonBarriers()
                              throws IOException,
                                     AutomationException

RecordSet of Polygon Barriers returned from the network analysis.

Remarks

PolygonBarriers contains the polygon barriers used in the analysis.

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.

getODMatrix

Object getODMatrix()
                   throws IOException,
                          AutomationException

3D array [origin, destination, cost] of OD-values returned from the network analysis.

Remarks

ODMatrix contains an internal 3-dimensional array representing the ODMatrix.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginOIDIndex

int[] getOriginOIDIndex()
                        throws IOException,
                               AutomationException

Array of mappings of the Origin OIDs into ODMatrix array index values.

Remarks

OriginOIDIndex contains an array that can be used to lookup the ObjectID in the origins RecordSet based on the index in the ODMatrix.

Product Availability

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

Returns:

The originOIDIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationOIDIndex

int[] getDestinationOIDIndex()
                             throws IOException,
                                    AutomationException

Array of mappings of the Destination OIDs into ODMatrix array index values.

Remarks

DestinationOIDIndex contains an array that can be used to lookup the ObjectID in the destinations RecordSet based on the index in the ODMatrix

Product Availability

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

Returns:

The destinationOIDIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCostAttributeNameIndex

String[] getCostAttributeNameIndex()
                                   throws IOException,
                                          AutomationException

Array of mappings of the cost attribute names into ODMatrix array index values.

Remarks

CostAttributeNameIndex contains the array of cost attributes in the ODMatrix.

Product Availability

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

Returns:

The costAttributeNameIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.