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

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

public class UpgradeNetwork
extends AbstractGPTool

Upgrades the schema of the network dataset. Upgrading the network dataset allows the network dataset to make use of the new functionality available in the current software release. The Upgrade Network tool is contained in the Network Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
UpgradeNetwork()
          Creates the Upgrade Network tool with defaults.
UpgradeNetwork(Object inNetworkDataset)
          Creates the Upgrade Network tool with the required parameters.
 
Method Summary
 Object getInNetworkDataset()
          Returns the Input Network Dataset parameter of this tool .
 Object getOutNetworkDataset()
          Returns the Output Network Dataset 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 setInNetworkDataset(Object inNetworkDataset)
          Sets the Input Network Dataset 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

UpgradeNetwork

public UpgradeNetwork()
Creates the Upgrade Network tool with defaults.

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


UpgradeNetwork

public UpgradeNetwork(Object inNetworkDataset)
Creates the Upgrade Network 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:
inNetworkDataset - the network dataset to be upgraded. The network dataset must be a geodatabase-based network dataset.
Method Detail

getInNetworkDataset

public Object getInNetworkDataset()
Returns the Input Network Dataset parameter of this tool . This parameter is the network dataset to be upgraded. The network dataset must be a geodatabase-based network dataset. This is a required parameter.

Returns:
the Input Network Dataset

setInNetworkDataset

public void setInNetworkDataset(Object inNetworkDataset)
Sets the Input Network Dataset parameter of this tool . This parameter is the network dataset to be upgraded. The network dataset must be a geodatabase-based network dataset. This is a required parameter.

Parameters:
inNetworkDataset - the network dataset to be upgraded. The network dataset must be a geodatabase-based network dataset.

getOutNetworkDataset

public Object getOutNetworkDataset()
Returns the Output Network Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Network Dataset

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