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

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

public class TurnTableToTurnFeatureClass
extends AbstractGPTool

Converts an ArcView GIS turn table or ArcInfo Workstation coverage turn table to an ArcGIS turn feature class. The Turn Table To Turn Feature Class 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
TurnTableToTurnFeatureClass()
          Creates the Turn Table To Turn Feature Class tool with defaults.
TurnTableToTurnFeatureClass(Object inTurnTable, Object referenceLineFeatures, String outFeatureClassName)
          Creates the Turn Table To Turn Feature Class tool with the required parameters.
 
Method Summary
 String getConfigKeyword()
          Returns the Config Keyword parameter of this tool .
 Object getInTurnTable()
          Returns the Input Turn Table parameter of this tool .
 int getMaximumEdges()
          Returns the Maximum Edges parameter of this tool .
 String getOutFeatureClassName()
          Returns the Output Turn Feature Class Name parameter of this tool .
 Object getOutTurnFeatures()
          Returns the Output Turn Feature Class parameter of this tool (Read only).
 Object getReferenceLineFeatures()
          Returns the Reference Line Features parameter of this tool .
 Object getReferenceNodesTable()
          Returns the Reference Nodes Table parameter of this tool .
 double getSpatialGrid1()
          Returns the Output Spatial Grid 1 parameter of this tool .
 double getSpatialGrid2()
          Returns the Output Spatial Grid 2 parameter of this tool .
 double getSpatialGrid3()
          Returns the Output Spatial Grid 3 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 setConfigKeyword(String configKeyword)
          Sets the Config Keyword parameter of this tool .
 void setInTurnTable(Object inTurnTable)
          Sets the Input Turn Table parameter of this tool .
 void setMaximumEdges(int maximumEdges)
          Sets the Maximum Edges parameter of this tool .
 void setOutFeatureClassName(String outFeatureClassName)
          Sets the Output Turn Feature Class Name parameter of this tool .
 void setReferenceLineFeatures(Object referenceLineFeatures)
          Sets the Reference Line Features parameter of this tool .
 void setReferenceNodesTable(Object referenceNodesTable)
          Sets the Reference Nodes Table parameter of this tool .
 void setSpatialGrid1(double spatialGrid1)
          Sets the Output Spatial Grid 1 parameter of this tool .
 void setSpatialGrid2(double spatialGrid2)
          Sets the Output Spatial Grid 2 parameter of this tool .
 void setSpatialGrid3(double spatialGrid3)
          Sets the Output Spatial Grid 3 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

TurnTableToTurnFeatureClass

public TurnTableToTurnFeatureClass()
Creates the Turn Table To Turn Feature Class tool with defaults.

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


TurnTableToTurnFeatureClass

public TurnTableToTurnFeatureClass(Object inTurnTable,
                                   Object referenceLineFeatures,
                                   String outFeatureClassName)
Creates the Turn Table To Turn Feature Class 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:
inTurnTable - Table View, the .dbf or INFO turn table from which the new turn feature class is being created.
referenceLineFeatures - Feature Class, the line feature class to which the input turn table refers. The feature class must be a source in a network dataset.
outFeatureClassName - String, the name of the new turn feature class being created.
Method Detail

getInTurnTable

public Object getInTurnTable()
Returns the Input Turn Table parameter of this tool . This parameter is Table View, the .dbf or INFO turn table from which the new turn feature class is being created. This is a required parameter.

Returns:
the Input Turn Table

setInTurnTable

public void setInTurnTable(Object inTurnTable)
Sets the Input Turn Table parameter of this tool . This parameter is Table View, the .dbf or INFO turn table from which the new turn feature class is being created. This is a required parameter.

Parameters:
inTurnTable - Table View, the .dbf or INFO turn table from which the new turn feature class is being created.

getReferenceLineFeatures

public Object getReferenceLineFeatures()
Returns the Reference Line Features parameter of this tool . This parameter is Feature Class, the line feature class to which the input turn table refers. The feature class must be a source in a network dataset. This is a required parameter.

Returns:
the Reference Line Features

setReferenceLineFeatures

public void setReferenceLineFeatures(Object referenceLineFeatures)
Sets the Reference Line Features parameter of this tool . This parameter is Feature Class, the line feature class to which the input turn table refers. The feature class must be a source in a network dataset. This is a required parameter.

Parameters:
referenceLineFeatures - Feature Class, the line feature class to which the input turn table refers. The feature class must be a source in a network dataset.

getOutFeatureClassName

public String getOutFeatureClassName()
Returns the Output Turn Feature Class Name parameter of this tool . This parameter is String, the name of the new turn feature class being created. This is a required parameter.

Returns:
the Output Turn Feature Class Name

setOutFeatureClassName

public void setOutFeatureClassName(String outFeatureClassName)
Sets the Output Turn Feature Class Name parameter of this tool . This parameter is String, the name of the new turn feature class being created. This is a required parameter.

Parameters:
outFeatureClassName - String, the name of the new turn feature class being created.

getReferenceNodesTable

public Object getReferenceNodesTable()
Returns the Reference Nodes Table parameter of this tool . This parameter is dBASE Table, errors will be reported in an error file written to the same workspace as the reference line features. This is an optional parameter.

Returns:
the Reference Nodes Table

setReferenceNodesTable

public void setReferenceNodesTable(Object referenceNodesTable)
Sets the Reference Nodes Table parameter of this tool . This parameter is dBASE Table, errors will be reported in an error file written to the same workspace as the reference line features. This is an optional parameter.

Parameters:
referenceNodesTable - dBASE Table, errors will be reported in an error file written to the same workspace as the reference line features.

getMaximumEdges

public int getMaximumEdges()
Returns the Maximum Edges parameter of this tool . This parameter is Long, the maximum number of edges per turn in the new turn feature class. The default value is 5. The maximum value is 20. This is an optional parameter.

Returns:
the Maximum Edges

setMaximumEdges

public void setMaximumEdges(int maximumEdges)
Sets the Maximum Edges parameter of this tool . This parameter is Long, the maximum number of edges per turn in the new turn feature class. The default value is 5. The maximum value is 20. This is an optional parameter.

Parameters:
maximumEdges - Long, the maximum number of edges per turn in the new turn feature class. The default value is 5. The maximum value is 20.

getConfigKeyword

public String getConfigKeyword()
Returns the Config Keyword parameter of this tool . This parameter is String, geodatabase configuration keyword to be applied if the output is an ArcSDE geodatabase. The default value is no configuration keyword setting. This is an optional parameter.

Returns:
the Config Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Config Keyword parameter of this tool . This parameter is String, geodatabase configuration keyword to be applied if the output is an ArcSDE geodatabase. The default value is no configuration keyword setting. This is an optional parameter.

Parameters:
configKeyword - String, geodatabase configuration keyword to be applied if the output is an ArcSDE geodatabase. The default value is no configuration keyword setting.

getSpatialGrid1

public double getSpatialGrid1()
Returns the Output Spatial Grid 1 parameter of this tool . This parameter is Double, the default first spatial index value is the same first grid size as the reference line feature class. For most data, only a single grid size is required. This is an optional parameter.

Returns:
the Output Spatial Grid 1

setSpatialGrid1

public void setSpatialGrid1(double spatialGrid1)
Sets the Output Spatial Grid 1 parameter of this tool . This parameter is Double, the default first spatial index value is the same first grid size as the reference line feature class. For most data, only a single grid size is required. This is an optional parameter.

Parameters:
spatialGrid1 - Double, the default first spatial index value is the same first grid size as the reference line feature class. For most data, only a single grid size is required.

getSpatialGrid2

public double getSpatialGrid2()
Returns the Output Spatial Grid 2 parameter of this tool . This parameter is Double, for most data, only a single index size is required. Because feature size is an important factor in determining an optimum index size, data that contains features of very different sizes may require additional index sizes. Each index size must be at least three times the previous index size. This is an optional parameter.

Returns:
the Output Spatial Grid 2

setSpatialGrid2

public void setSpatialGrid2(double spatialGrid2)
Sets the Output Spatial Grid 2 parameter of this tool . This parameter is Double, for most data, only a single index size is required. Because feature size is an important factor in determining an optimum index size, data that contains features of very different sizes may require additional index sizes. Each index size must be at least three times the previous index size. This is an optional parameter.

Parameters:
spatialGrid2 - Double, for most data, only a single index size is required. Because feature size is an important factor in determining an optimum index size, data that contains features of very different sizes may require additional index sizes. Each index size must be at least three times the previous index size.

getSpatialGrid3

public double getSpatialGrid3()
Returns the Output Spatial Grid 3 parameter of this tool . This parameter is Double, for most data, only a single index size is required. Because feature size is an important factor determining an optimum index size, data that contains features of very different sizes may require additional index sizes. Each index size must be at least three times the previous index size. This is an optional parameter.

Returns:
the Output Spatial Grid 3

setSpatialGrid3

public void setSpatialGrid3(double spatialGrid3)
Sets the Output Spatial Grid 3 parameter of this tool . This parameter is Double, for most data, only a single index size is required. Because feature size is an important factor determining an optimum index size, data that contains features of very different sizes may require additional index sizes. Each index size must be at least three times the previous index size. This is an optional parameter.

Parameters:
spatialGrid3 - Double, for most data, only a single index size is required. Because feature size is an important factor determining an optimum index size, data that contains features of very different sizes may require additional index sizes. Each index size must be at least three times the previous index size.

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