com.esri.arcgis.networkanalyst
Interface INARouteSolver

All Superinterfaces:

Serializable

All Known Subinterfaces:

INARouteSolver2

All Known Implementing Classes:

NARouteSolver, NAServerRouteParams

public interface INARouteSolver
extends Serializable

Provides access to the route solver.

Superseded By

INARouteSolver2

Remarks

INARouteSolver has been superseded by INARouteSolver2.

Product Availability

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

Method Summary

int	getOutputLines() Indicates if lines will be generated in the result.
boolean	isCreateTraversalResult() Indicates if a traversal result will be generated.
boolean	isFindBestSequence() Indicates if the solver should resequence the route in the optimal order.
boolean	isPreserveFirstStop() Indicates if the solver should keep the first stop fixed in the sequence.
boolean	isPreserveLastStop() Indicates if the solver should keep the last stop fixed in the sequence.
boolean	isUseTimeWindows() Indicates if the solver should consider time windows.
void	setCreateTraversalResult(boolean value) Indicates if a traversal result will be generated.
void	setFindBestSequence(boolean value) Indicates if the solver should resequence the route in the optimal order.
void	setOutputLines(int value) Indicates if lines will be generated in the result.
void	setPreserveFirstStop(boolean value) Indicates if the solver should keep the first stop fixed in the sequence.
void	setPreserveLastStop(boolean value) Indicates if the solver should keep the last stop fixed in the sequence.
void	setUseTimeWindows(boolean value) Indicates if the solver should consider time windows.

Method Detail

isFindBestSequence

boolean isFindBestSequence()
                           throws IOException,
                                  AutomationException

Indicates if the solver should resequence the route in the optimal order.

Remarks

FindBestSequence determines whether or not the route solver optimizes the sequence of stops before solving the shortest path.

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.

setFindBestSequence

void setFindBestSequence(boolean value)
                         throws IOException,
                                AutomationException

Indicates if the solver should resequence the route in the optimal order.

Remarks

FindBestSequence determines whether or not the route solver optimizes the sequence of stops before solving the shortest path.

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.

isPreserveFirstStop

boolean isPreserveFirstStop()
                            throws IOException,
                                   AutomationException

Indicates if the solver should keep the first stop fixed in the sequence.

Remarks

PreserveFirstStop allows the first stop to stay as the first stop if the FindBestSequence has been turned on to optimize the sequence of stops.

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.

setPreserveFirstStop

void setPreserveFirstStop(boolean value)
                          throws IOException,
                                 AutomationException

Indicates if the solver should keep the first stop fixed in the sequence.

Remarks

PreserveFirstStop allows the first stop to stay as the first stop if the FindBestSequence has been turned on to optimize the sequence of stops.

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.

isPreserveLastStop

boolean isPreserveLastStop()
                           throws IOException,
                                  AutomationException

Indicates if the solver should keep the last stop fixed in the sequence.

Remarks

PreserveLastStop allows the last stop to stay as the last stop if the FindBestSequence has been turned on to optimize the sequence of stops.

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.

setPreserveLastStop

void setPreserveLastStop(boolean value)
                         throws IOException,
                                AutomationException

Indicates if the solver should keep the last stop fixed in the sequence.

Remarks

PreserveLastStop allows the last stop to stay as the last stop if the FindBestSequence has been turned on to optimize the sequence of stops.

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.

isUseTimeWindows

boolean isUseTimeWindows()
                         throws IOException,
                                AutomationException

Indicates if the solver should consider time windows.

Remarks

UseTimeWindows allows the use of time windows on individual stops. The route solver will change the sequence of the stops to satisfy the time windows. This is done regardless of settings for FindBestSequence.

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.

setUseTimeWindows

void setUseTimeWindows(boolean value)
                       throws IOException,
                              AutomationException

Indicates if the solver should consider time windows.

Remarks

UseTimeWindows allows the use of time windows on individual stops. The route solver will change the sequence of the stops to satisfy the time windows. This is done regardless of settings for FindBestSequence.

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.

isCreateTraversalResult

boolean isCreateTraversalResult()
                                throws IOException,
                                       AutomationException

Indicates if a traversal result will be generated.

Remarks

CreateTraversalResult specifies if the traversal results will be created by the route 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.

setCreateTraversalResult

void setCreateTraversalResult(boolean value)
                              throws IOException,
                                     AutomationException

Indicates if a traversal result will be generated.

Remarks

CreateTraversalResult specifies if the traversal results will be created by the route 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.

getOutputLines

int getOutputLines()
                   throws IOException,
                          AutomationException

Indicates if lines will be generated in the result.

Remarks

OutputLines specifies the type of lines that are generated by the solver. The type can be true shape, true shape with measures, straight lines connecting the stops or no lines.

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 if lines will be generated in the result.

Remarks

OutputLines specifies the type of lines that are generated by the solver. The type can be true shape, true shape with measures, straight lines connecting the stops 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.