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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.networkanalysttools.Solve
All Implemented Interfaces:
GPTool

public class Solve
extends AbstractGPTool

Performs the analysis appropriate to the network analysis layer on which it is executed. The Solve tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:


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 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 .
 
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 - Network Analyst Layer, the network analysis layer on which analysis will be computed.
Method Detail

getInNetworkAnalysisLayer

public Object getInNetworkAnalysisLayer()
Returns the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, the network analysis layer on which 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 Network Analyst Layer, the network analysis layer on which analysis will be computed. This is a required parameter.

Parameters:
inNetworkAnalysisLayer - Network Analyst Layer, the network analysis layer on which analysis will be computed.

getIgnoreInvalids

public String getIgnoreInvalids()
Returns the Ignore invalid locations parameter of this tool . This parameter is String, if the input network analysis layer parameter is a vehicle routing problem layer, the solve tool will always use the HALT option as the vehicle routing problem solver requires that the invalid locations are not ignored. 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 String, if the input network analysis layer parameter is a vehicle routing problem layer, the solve tool will always use the HALT option as the vehicle routing problem solver requires that the invalid locations are not ignored. This is an optional parameter.

Parameters:
ignoreInvalids - String, if the input network analysis layer parameter is a vehicle routing problem layer, the solve tool will always use the HALT option as the vehicle routing problem solver requires that the invalid locations are not ignored.

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

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