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

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

public class CreateTurnFeatureClass
extends AbstractGPTool

Creates a new turn feature class. The Create 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
CreateTurnFeatureClass()
          Creates the Create Turn Feature Class tool with defaults.
CreateTurnFeatureClass(Object outLocation, String outFeatureClassName)
          Creates the Create Turn Feature Class tool with the required parameters.
 
Method Summary
 String getConfigKeyword()
          Returns the Config Keyword parameter of this tool .
 Object getInNetworkDataset()
          Returns the Input Network Dataset parameter of this tool .
 Object getInTemplateFeatureClass()
          Returns the Template Feature Class 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 getOutLocation()
          Returns the Output Location parameter of this tool .
 Object getOutTurnFeatures()
          Returns the Output Turn Feature Class parameter of this tool (Read only).
 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 .
 Object getSpatialReference()
          Returns the Spatial Reference 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 setInNetworkDataset(Object inNetworkDataset)
          Sets the Input Network Dataset parameter of this tool .
 void setInTemplateFeatureClass(Object inTemplateFeatureClass)
          Sets the Template Feature Class 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 setOutLocation(Object outLocation)
          Sets the Output Location 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 .
 void setSpatialReference(Object spatialReference)
          Sets the Spatial Reference 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

CreateTurnFeatureClass

public CreateTurnFeatureClass()
Creates the Create Turn Feature Class tool with defaults.

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


CreateTurnFeatureClass

public CreateTurnFeatureClass(Object outLocation,
                              String outFeatureClassName)
Creates the Create 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:
outLocation - Workspace | Feature Dataset, the ArcSDE, personal geodatabase, or folder workspace in which the output turn feature class will be created. It must exist before executing this tool.
outFeatureClassName - String, the turn feature class to be created.
Method Detail

getOutLocation

public Object getOutLocation()
Returns the Output Location parameter of this tool . This parameter is Workspace | Feature Dataset, the ArcSDE, personal geodatabase, or folder workspace in which the output turn feature class will be created. It must exist before executing this tool. This is a required parameter.

Returns:
the Output Location

setOutLocation

public void setOutLocation(Object outLocation)
Sets the Output Location parameter of this tool . This parameter is Workspace | Feature Dataset, the ArcSDE, personal geodatabase, or folder workspace in which the output turn feature class will be created. It must exist before executing this tool. This is a required parameter.

Parameters:
outLocation - Workspace | Feature Dataset, the ArcSDE, personal geodatabase, or folder workspace in which the output turn feature class will be created. It must exist before executing this tool.

getOutFeatureClassName

public String getOutFeatureClassName()
Returns the Output Turn Feature Class Name parameter of this tool . This parameter is String, the turn feature class to be 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 turn feature class to be created. This is a required parameter.

Parameters:
outFeatureClassName - String, the turn feature class to be created.

getMaximumEdges

public int getMaximumEdges()
Returns the Maximum Edges parameter of this tool . This parameter is Long, the maximum number of edges that turns in the new turn feature class can model. 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 that turns in the new turn feature class can model. The default value is 5. The maximum value is 20. This is an optional parameter.

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

getInNetworkDataset

public Object getInNetworkDataset()
Returns the Input Network Dataset parameter of this tool . This parameter is Network Dataset Layer, the network dataset in which the turn feature class will participate. If no network dataset is specified, the turn feature class will be created as not participating in a network dataset. This is an optional parameter.

Returns:
the Input Network Dataset

setInNetworkDataset

public void setInNetworkDataset(Object inNetworkDataset)
Sets the Input Network Dataset parameter of this tool . This parameter is Network Dataset Layer, the network dataset in which the turn feature class will participate. If no network dataset is specified, the turn feature class will be created as not participating in a network dataset. This is an optional parameter.

Parameters:
inNetworkDataset - Network Dataset Layer, the network dataset in which the turn feature class will participate. If no network dataset is specified, the turn feature class will be created as not participating in a network dataset.

getInTemplateFeatureClass

public Object getInTemplateFeatureClass()
Returns the Template Feature Class parameter of this tool . This parameter is Feature Layer, the feature class used as a template to define the attribute schema of the new turn feature class. This is an optional parameter.

Returns:
the Template Feature Class

setInTemplateFeatureClass

public void setInTemplateFeatureClass(Object inTemplateFeatureClass)
Sets the Template Feature Class parameter of this tool . This parameter is Feature Layer, the feature class used as a template to define the attribute schema of the new turn feature class. This is an optional parameter.

Parameters:
inTemplateFeatureClass - Feature Layer, the feature class used as a template to define the attribute schema of the new turn feature class.

getSpatialReference

public Object getSpatialReference()
Returns the Spatial Reference parameter of this tool . This parameter is Spatial Reference, the spatial reference to be applied to the output turn feature class. This parameter is ignored if the output location is a geodatabase feature dataset, and the feature class will inherit the spatial reference of the feature dataset. This is an optional parameter.

Returns:
the Spatial Reference

setSpatialReference

public void setSpatialReference(Object spatialReference)
Sets the Spatial Reference parameter of this tool . This parameter is Spatial Reference, the spatial reference to be applied to the output turn feature class. This parameter is ignored if the output location is a geodatabase feature dataset, and the feature class will inherit the spatial reference of the feature dataset. This is an optional parameter.

Parameters:
spatialReference - Spatial Reference, the spatial reference to be applied to the output turn feature class. This parameter is ignored if the output location is a geodatabase feature dataset, and the feature class will inherit the spatial reference of the feature dataset.

getConfigKeyword

public String getConfigKeyword()
Returns the Config Keyword parameter of this tool . This parameter is String, the configuration keyword, which determines the storage parameters of the new turn feature class in a 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, the configuration keyword, which determines the storage parameters of the new turn feature class in a ArcSDE geodatabase. The default value is no configuration keyword setting. This is an optional parameter.

Parameters:
configKeyword - String, the configuration keyword, which determines the storage parameters of the new turn feature class in a 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 1000. 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 1000. 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 1000. 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 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 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 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:
spatialGrid3 - 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.

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