com.esri.arcgis.networkanalyst
Interface INAODCostMatrixSolver

All Superinterfaces:

Serializable

All Known Subinterfaces:

INAODCostMatrixSolver2

All Known Implementing Classes:

NAODCostMatrixSolver, NAServerODCostMatrixParams

public interface INAODCostMatrixSolver
extends Serializable

Provides access to the origin-destination matrix solver.

Superseded By

INAODCostMatrixSolver2

Remarks

INAODCostMatrixSolver has been superseded by INAODCostMatrixSolver2.

Product Availability

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

Method Summary

Object	getDefaultCutoff() The default cutoff value to stop traversing.
Object	getDefaultTargetDestinationCount() The default number of destinations to find.
int	getOutputLines() Indicates how lines are generated.
void	setDefaultCutoff(Object value) The default cutoff value to stop traversing.
void	setDefaultTargetDestinationCount(Object value) The default number of destinations to find.
void	setOutputLines(int value) Indicates how lines are generated.

Method Detail

getDefaultTargetDestinationCount

Object getDefaultTargetDestinationCount()
                                        throws IOException,
                                               AutomationException

The default number of destinations to find.

Remarks

DefaultTargetDestinationCount specifies the number of destinations to find for the NAODCostMatrixSolver. For example, solving for 10 destinations will return the cost-distance to the 10 closest destinations from each origin.

DefaultTargetDestinationCount is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the TargetDestinationCount field of an individual feature.

DefaultTargetDestinationCount, if not NULL, can be cast as an integer. It is returned as an object/variant in order to allow a NULL value to be used to specify an unlimited default destination count. A DefaultTargetDestinationCount of NULL indicates that a path will be found, if possible, between every origin and every destination.

If a specific origin feature has a non-null value in the TargetDestinationCount field of its NAClass, this value will override the DefaultTargetDestinationCount for that origin.

If an attempt is made to set the DefaultTargetDestinationCount to a non-integer value, it will be rounded to the nearest integer.

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.

setDefaultTargetDestinationCount

void setDefaultTargetDestinationCount(Object value)
                                      throws IOException,
                                             AutomationException

The default number of destinations to find.

Remarks

DefaultTargetDestinationCount specifies the number of destinations to find for the NAODCostMatrixSolver. For example, solving for 10 destinations will return the cost-distance to the 10 closest destinations from each origin.

DefaultTargetDestinationCount is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the TargetDestinationCount field of an individual feature.

DefaultTargetDestinationCount, if not NULL, can be cast as an integer. It is returned as an object/variant in order to allow a NULL value to be used to specify an unlimited default destination count. A DefaultTargetDestinationCount of NULL indicates that a path will be found, if possible, between every origin and every destination.

If a specific origin feature has a non-null value in the TargetDestinationCount field of its NAClass, this value will override the DefaultTargetDestinationCount for that origin.

If an attempt is made to set the DefaultTargetDestinationCount to a non-integer value, it will be rounded to the nearest integer.

Product Availability

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

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCutoff

Object getDefaultCutoff()
                        throws IOException,
                               AutomationException

The default cutoff value to stop traversing.

Remarks

DefaultCutoff specifies how far to search for the destinations around each origin. For example, setting a default cutoff of 10 miles will only return those destinations within 10 miles from each origin.

DefaultCutoff is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the Cutoff_<attribute name> field of an individual feature.

DefaultCutoff, if not NULL, can be cast as a double. It is returned as an object/variant in order to allow a NULL to be used to specify no default cutoff value. A DefaultCutoff of zero indicates a search distance of zero. A DefaultCutoff of NULL indicates an unlimited search distance.

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.

setDefaultCutoff

void setDefaultCutoff(Object value)
                      throws IOException,
                             AutomationException

The default cutoff value to stop traversing.

Remarks

DefaultCutoff specifies how far to search for the destinations around each origin. For example, setting a default cutoff of 10 miles will only return those destinations within 10 miles from each origin.

DefaultCutoff is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the Cutoff_<attribute name> field of an individual feature.

DefaultCutoff, if not NULL, can be cast as a double. It is returned as an object/variant in order to allow a NULL to be used to specify no default cutoff value. A DefaultCutoff of zero indicates a search distance of zero. A DefaultCutoff of NULL indicates an unlimited search distance.

Product Availability

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

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputLines

int getOutputLines()
                   throws IOException,
                          AutomationException

Indicates how lines are generated.

Remarks

OutputLines specifies the type of lines that are generated by the NAODCostMatrixSolver object.

The only two valid line types for a NAODCostMatrixSolver are esriNAOutputLineNone or esriNAOutputLineStraight. The determined path from an origin to a destination is a true network path, but the only allowed representation of that path is a straight line or no lines at all.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputLines

void setOutputLines(int value)
                    throws IOException,
                           AutomationException

Indicates how lines are generated.

Remarks

OutputLines specifies the type of lines that are generated by the NAODCostMatrixSolver object.

The type can be straight lines connecting the origins and destinations or no lines.

Product Availability

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

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.