com.esri.arcgis.networkanalyst
Interface INAODCostMatrixSolver2

All Superinterfaces:

INAODCostMatrixSolver, Serializable

All Known Implementing Classes:

NAODCostMatrixSolver, NAServerODCostMatrixParams

public interface INAODCostMatrixSolver2
extends INAODCostMatrixSolver, Serializable

Provides access to the OD cost matrix solver.

Description

This interface is new at ArcGIS 9.3. It supersedes INAODCostMatrixSolver.

Remarks

INAODCostMatrixSolver2 is the interface provided on the NAODCostMatrixSolver object to access the properties of the OD Cost Matrix solver.

Product Availability

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

Method Summary

int	getMatrixResultType() Indicates the type of matrix result to be created.
boolean	isPopulateODLines() Indicates if the ODLines class is to be populated.
void	setMatrixResultType(int type) Indicates the type of matrix result to be created.
void	setPopulateODLines(boolean value) Indicates if the ODLines class is to be populated.

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

getDefaultCutoff, getDefaultTargetDestinationCount, getOutputLines, setDefaultCutoff, setDefaultTargetDestinationCount, setOutputLines

Method Detail

getMatrixResultType

int getMatrixResultType()
                        throws IOException,
                               AutomationException

Indicates the type of matrix result to be created.

Remarks

Specifies what type of a cost matrix is created during a solve.

If the solver is set to produce a matrix (either esriNAODCostMatrixFull or esriNAODCostMatrixUpdate), make sure that the PopulateODLines property is set to False as only one of these can be populated by the solver.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNAODCostMatrixType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMatrixResultType

void setMatrixResultType(int type)
                         throws IOException,
                                AutomationException

Indicates the type of matrix result to be created.

Remarks

Specifies what type of a cost matrix is created during a solve.

If the solver is set to produce a matrix (either esriNAODCostMatrixFull or esriNAODCostMatrixUpdate), make sure that the PopulateODLines property is set to False as only one these can be populated by the solver.

Product Availability

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

Parameters:

type - A com.esri.arcgis.networkanalyst.esriNAODCostMatrixType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPopulateODLines

boolean isPopulateODLines()
                          throws IOException,
                                 AutomationException

Indicates if the ODLines class is to be populated.

Remarks

Specifies if the solver should populate the ODLines output analysis class on solve.

If this is set to True, make sure that the MatrixResultType property is set to esriNAODCostMatrixNone as only one of these can be populated by the solver.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPopulateODLines

void setPopulateODLines(boolean value)
                        throws IOException,
                               AutomationException

Indicates if the ODLines class is to be populated.

Description

Returns true if the solver is set to populated the ODLines output analysis layer. If this is set true then the Matrix Result type cannot be populated. That is, the solver can either populate the ODLines or the Matrix result type.

Remarks

Specifies if the solver should populate the ODLines output analyis class on solve.

If this is set to True, make sure that the MatrixResultType property is set to esriNAODCostMatrixNone as only one these can be populated by the solver.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.