com.esri.arcgis.networkanalyst
Interface INAServerODCostMatrixParams

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Implementing Classes:

NAServerODCostMatrixParams

public interface INAServerODCostMatrixParams
extends INAServerSolverParams, Serializable

Provides access to properties that specify the Origin-Destination Cost Matrix solver settings and return parameters used during network analysis with NAServer.

Remarks

INAServerODCostMatrixParams provides methods to set input parameters on an NAServerODCostMatrixParams object that is then used by the Solve method on INAServer to calculate origin-destination cost matrix.

Product Availability

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

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
INAServerLocations	getDestinations() RecordSet or array of PropertySets representing Destinations loaded as network locations during analysis.
INAServerLocations	getOrigins() RecordSet or array of PropertySets representing Origins loaded as network locations during analysis.
INAServerLocations	getPolygonBarriers() RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
INAServerLocations	getPolylineBarriers() RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
boolean	isReturnBarriers() Indicates if the output barriers recordset should be returned with the analysis results.
boolean	isReturnDestinations() Indicates if the output Destinations recordset should be returned with the analysis results.
boolean	isReturnODLines() Indicates if the output ODRoutes recordset should be returned with the analysis results.
boolean	isReturnODMatrix() Indicates if the caluclated OD-values and index arrays should be returned with the analysis results.
boolean	isReturnOrigins() Indicates if the output Origins recordset should be returned with the analysis results.
boolean	isReturnPolygonBarriers() Indicates if the output polygon barriers recordset should be returned with the analysis results.
boolean	isReturnPolylineBarriers() Indicates if the output polyline barriers recordset should be returned with the analysis results.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setDestinationsByRef(INAServerLocations destinations) RecordSet or array of PropertySets representing Destinations loaded as network locations during analysis.
void	setOriginsByRef(INAServerLocations origins) RecordSet or array of PropertySets representing Origins loaded as network locations during analysis.
void	setPolygonBarriersByRef(INAServerLocations polygonBarriers) RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
void	setPolylineBarriersByRef(INAServerLocations polylineBarriers) RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output barriers recordset should be returned with the analysis results.
void	setReturnDestinations(boolean returnDestinations) Indicates if the output Destinations recordset should be returned with the analysis results.
void	setReturnODLines(boolean returnODLines) Indicates if the output ODRoutes recordset should be returned with the analysis results.
void	setReturnODMatrix(boolean returnODMatrix) Indicates if the caluclated OD-values and index arrays should be returned with the analysis results.
void	setReturnOrigins(boolean returnOrigins) Indicates if the output Origins recordset should be returned with the analysis results.
void	setReturnPolygonBarriers(boolean returnBarriers) Indicates if the output polygon barriers recordset should be returned with the analysis results.
void	setReturnPolylineBarriers(boolean returnBarriers) Indicates if the output polyline barriers recordset should be returned with the analysis results.

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

getImageDescription, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isReturnMap, setImageDescriptionByRef, setMapDescriptionByRef, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputSpatialReferenceByRef, setReturnMap, setSnapTolerance, setSnapToleranceUnits

Method Detail

setOriginsByRef

void setOriginsByRef(INAServerLocations origins)
                     throws IOException,
                            AutomationException

RecordSet or array of PropertySets representing Origins loaded as network locations during analysis.

Remarks

Origins specifies an instance of NAServerLocations class to take into account when computing Origin-Destination Cost Matrix.

Product Availability

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

Parameters:

origins - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrigins

INAServerLocations getOrigins()
                              throws IOException,
                                     AutomationException

RecordSet or array of PropertySets representing Origins loaded as network locations during analysis.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationsByRef

void setDestinationsByRef(INAServerLocations destinations)
                          throws IOException,
                                 AutomationException

RecordSet or array of PropertySets representing Destinations loaded as network locations during analysis.

Remarks

Destinations specifies an instance of NAServerLocations class to take into account when computing Origin-Destination Cost Matrix.

Product Availability

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

Parameters:

destinations - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinations

INAServerLocations getDestinations()
                                   throws IOException,
                                          AutomationException

RecordSet or array of PropertySets representing Destinations loaded as network locations during analysis.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Remarks

Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarriers

INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolylineBarriersByRef

void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws IOException,
                                     AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Remarks

PolylineBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

Parameters:

polylineBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolylineBarriers

INAServerLocations getPolylineBarriers()
                                       throws IOException,
                                              AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonBarriersByRef

void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Remarks

PolygonBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

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

Parameters:

polygonBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonBarriers

INAServerLocations getPolygonBarriers()
                                      throws IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnODLines

void setReturnODLines(boolean returnODLines)
                      throws IOException,
                             AutomationException

Indicates if the output ODRoutes recordset should be returned with the analysis results.

Remarks

ReturnODLines indicates if the origin-destination line features should be returned as a RecordSet.

Product Availability

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

Parameters:

returnODLines - The returnODLines (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnODLines

boolean isReturnODLines()
                        throws IOException,
                               AutomationException

Indicates if the output ODRoutes recordset should be returned with the analysis results.

Product Availability

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

Returns:

The returnODLines

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnOrigins

void setReturnOrigins(boolean returnOrigins)
                      throws IOException,
                             AutomationException

Indicates if the output Origins recordset should be returned with the analysis results.

Remarks

ReturnOrigins indicates if the origins used during analysis should be returned as a RecordSet.

Product Availability

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

Parameters:

returnOrigins - The returnOrigins (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnOrigins

boolean isReturnOrigins()
                        throws IOException,
                               AutomationException

Indicates if the output Origins recordset should be returned with the analysis results.

Product Availability

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

Returns:

The returnOrigins

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDestinations

void setReturnDestinations(boolean returnDestinations)
                           throws IOException,
                                  AutomationException

Indicates if the output Destinations recordset should be returned with the analysis results.

Remarks

ReturnDestinations indicates if the destinations used during analysis should be returned as a RecordSet.

Product Availability

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

Parameters:

returnDestinations - The returnDestinations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDestinations

boolean isReturnDestinations()
                             throws IOException,
                                    AutomationException

Indicates if the output Destinations recordset should be returned with the analysis results.

Product Availability

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

Returns:

The returnDestinations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnODMatrix

void setReturnODMatrix(boolean returnODMatrix)
                       throws IOException,
                              AutomationException

Indicates if the caluclated OD-values and index arrays should be returned with the analysis results.

Remarks

ReturnODMatrix indicates if the ODMatrix result object should be populated and returned.

Product Availability

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

Parameters:

returnODMatrix - The returnODMatrix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnODMatrix

boolean isReturnODMatrix()
                         throws IOException,
                                AutomationException

Indicates if the caluclated OD-values and index arrays should be returned with the analysis results.

Product Availability

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

Returns:

The returnODMatrix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

void setReturnBarriers(boolean returnBarriers)
                       throws IOException,
                              AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Remarks

ReturnBarriers specifies if the Barriers are returned.

Product Availability

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

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

boolean isReturnBarriers()
                         throws IOException,
                                AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Product Availability

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

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnPolylineBarriers

void setReturnPolylineBarriers(boolean returnBarriers)
                               throws IOException,
                                      AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers are returned.

Product Availability

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

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPolylineBarriers

boolean isReturnPolylineBarriers()
                                 throws IOException,
                                        AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Product Availability

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

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnPolygonBarriers

void setReturnPolygonBarriers(boolean returnBarriers)
                              throws IOException,
                                     AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers are returned.

Product Availability

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

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPolygonBarriers

boolean isReturnPolygonBarriers()
                                throws IOException,
                                       AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Product Availability

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

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.