com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class Solve

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.networkanalysttools.Solve

All Implemented Interfaces:

GPTool

public class Solve
extends AbstractGPTool

Solves the network analysis layer problem based on its network locations and properties. The Solve tool is contained in the Network Analyst Tools tool box.

Usage tips:

• When the solve fails, the warning and error messages provide useful information about the reasons for the failure.
• Be sure to specify all the parameters on the network analysis layer that are necessary to solve the problem before running this tool.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Solve()
Creates the Solve tool with defaults.

Solve(Object inNetworkAnalysisLayer)
Creates the Solve tool with the required parameters.

Method Summary

String	getIgnoreInvalids() Returns the Ignore invalid locations parameter of this tool .
Object	getInNetworkAnalysisLayer() Returns the Input network analysis layer parameter of this tool .
Object	getOutputLayer() Returns the Network Analyst Layer parameter of this tool (Read only).
String	getSolveSucceeded() Returns the Solve succeeded parameter of this tool (Read only).
String	getTerminateOnSolveError() Returns the Terminate on solve error parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setIgnoreInvalids(String ignoreInvalids) Sets the Ignore invalid locations parameter of this tool .
void	setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer) Sets the Input network analysis layer parameter of this tool .
void	setTerminateOnSolveError(String terminateOnSolveError) Sets the Terminate on solve error parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Solve

public Solve()

Creates the Solve tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

Solve

public Solve(Object inNetworkAnalysisLayer)

Creates the Solve tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inNetworkAnalysisLayer - the network analysis layer on which the analysis will be computed.

Method Detail

getInNetworkAnalysisLayer

public Object getInNetworkAnalysisLayer()

Returns the Input network analysis layer parameter of this tool . This parameter is the network analysis layer on which the analysis will be computed. This is a required parameter.

Returns:

the Input network analysis layer

setInNetworkAnalysisLayer

public void setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer)

Sets the Input network analysis layer parameter of this tool . This parameter is the network analysis layer on which the analysis will be computed. This is a required parameter.

Parameters:

inNetworkAnalysisLayer - the network analysis layer on which the analysis will be computed.

getIgnoreInvalids

public String getIgnoreInvalids()

Returns the Ignore invalid locations parameter of this tool . This parameter is for vehicle routing problem network analysis layer, use HALT as the parameter value since the vehicle routing problem solver requires all the network locations to be valid. This is an optional parameter.

Returns:

the Ignore invalid locations

setIgnoreInvalids

public void setIgnoreInvalids(String ignoreInvalids)

Sets the Ignore invalid locations parameter of this tool . This parameter is for vehicle routing problem network analysis layer, use HALT as the parameter value since the vehicle routing problem solver requires all the network locations to be valid. This is an optional parameter.

Parameters:

ignoreInvalids - for vehicle routing problem network analysis layer, use HALT as the parameter value since the vehicle routing problem solver requires all the network locations to be valid.

getTerminateOnSolveError

public String getTerminateOnSolveError()

Returns the Terminate on solve error parameter of this tool . This is an optional parameter.

Returns:

the Terminate on solve error

setTerminateOnSolveError

public void setTerminateOnSolveError(String terminateOnSolveError)

Sets the Terminate on solve error parameter of this tool . This is an optional parameter.

Parameters:

terminateOnSolveError - null

getOutputLayer

public Object getOutputLayer()

Returns the Network Analyst Layer parameter of this tool (Read only). This is an derived parameter.

Returns:

the Network Analyst Layer

getSolveSucceeded

public String getSolveSucceeded()

Returns the Solve succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:

the Solve succeeded

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias