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

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

public class IncreaseMaximumEdges
extends AbstractGPTool

Increases the maximum number of edges in a turn feature class. The Increase Maximum Edges 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
IncreaseMaximumEdges()
          Creates the Increase Maximum Edges tool with defaults.
IncreaseMaximumEdges(Object inTurnFeatures, int maximumEdges)
          Creates the Increase Maximum Edges tool with the required parameters.
 
Method Summary
 Object getInTurnFeatures()
          Returns the Input Turn Feature Class parameter of this tool .
 int getMaximumEdges()
          Returns the Maximum Edges parameter of this tool .
 Object getOutTurnFeatures()
          Returns the Output Turn Feature Class 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 setInTurnFeatures(Object inTurnFeatures)
          Sets the Input Turn Feature Class parameter of this tool .
 void setMaximumEdges(int maximumEdges)
          Sets the Maximum Edges 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

IncreaseMaximumEdges

public IncreaseMaximumEdges()
Creates the Increase Maximum Edges tool with defaults.

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


IncreaseMaximumEdges

public IncreaseMaximumEdges(Object inTurnFeatures,
                            int maximumEdges)
Creates the Increase Maximum Edges 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:
inTurnFeatures - Feature Layer, the turn feature class that is having its maximum number of edges raised.
maximumEdges - Long, the new maximum number of edges in the input turn feature class. The value must be at least one higher than the existing maximum number of edges.
Method Detail

getInTurnFeatures

public Object getInTurnFeatures()
Returns the Input Turn Feature Class parameter of this tool . This parameter is Feature Layer, the turn feature class that is having its maximum number of edges raised. This is a required parameter.

Returns:
the Input Turn Feature Class

setInTurnFeatures

public void setInTurnFeatures(Object inTurnFeatures)
Sets the Input Turn Feature Class parameter of this tool . This parameter is Feature Layer, the turn feature class that is having its maximum number of edges raised. This is a required parameter.

Parameters:
inTurnFeatures - Feature Layer, the turn feature class that is having its maximum number of edges raised.

getMaximumEdges

public int getMaximumEdges()
Returns the Maximum Edges parameter of this tool . This parameter is Long, the new maximum number of edges in the input turn feature class. The value must be at least one higher than the existing maximum number of edges. This is a required parameter.

Returns:
the Maximum Edges

setMaximumEdges

public void setMaximumEdges(int maximumEdges)
Sets the Maximum Edges parameter of this tool . This parameter is Long, the new maximum number of edges in the input turn feature class. The value must be at least one higher than the existing maximum number of edges. This is a required parameter.

Parameters:
maximumEdges - Long, the new maximum number of edges in the input turn feature class. The value must be at least one higher than the existing maximum number of edges.

getOutTurnFeatures

public Object getOutTurnFeatures()
Returns the Output Turn Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Turn Feature Class

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