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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.networkanalysttools.CreateTurnFeatureClass

All Implemented Interfaces:

GPTool

public class CreateTurnFeatureClass
extends AbstractGPTool

Creates a new turn feature class to store turn features that model turning movements in a network dataset. The Create Turn Feature Class tool is contained in the Network Analyst Tools tool box.

Usage tips:

• You can add a turn feature class as a turn sources to your network only if your network dataset supports turns. If you want to add turns to a network that does not support turns, you will have to create a new network dataset that supports turns.
• After creating the turn feature class, the turn features can be created in ArcMap using the commands to create linear features on the Editor toolbar.

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 .
String	getHasZ() Returns the Has Z 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	setHasZ(String hasZ) Sets the Has Z 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 - the ArcSDE, file, or personal geodatabase, or the folder in which the output turn feature class will be created. This workspace must already exist.

outFeatureClassName - the name of the turn feature class to be created.

Method Detail

getOutLocation

public Object getOutLocation()

Returns the Output Location parameter of this tool . This parameter is the ArcSDE, file, or personal geodatabase, or the folder in which the output turn feature class will be created. This workspace must already exist. 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 the ArcSDE, file, or personal geodatabase, or the folder in which the output turn feature class will be created. This workspace must already exist. This is a required parameter.

Parameters:

outLocation - the ArcSDE, file, or personal geodatabase, or the folder in which the output turn feature class will be created. This workspace must already exist.

getOutFeatureClassName

public String getOutFeatureClassName()

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

Parameters:

outFeatureClassName - the name of the turn feature class to be created.

getMaximumEdges

public int getMaximumEdges()

Returns the Maximum Edges parameter of this tool . This parameter is 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 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 - 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 the network dataset in which the turn feature class will participate. The resulting turn feature class will be added as a turn source to the network dataset. 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 the network dataset in which the turn feature class will participate. The resulting turn feature class will be added as a turn source to the network dataset. 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 - the network dataset in which the turn feature class will participate. The resulting turn feature class will be added as a turn source to the network dataset. 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 the feature class used as a template to define the attribute schema of the new turn feature class. if the template feature class has the following fields, they are not created on the output turn feature class; NODE_, NODE#, JUNCTION, F_EDGE, T_EDGE, F-EDGE, T-EDGE, ARC1_,ARC2_,ARC1#,ARC2#,ARC1-ID, ARC2-ID, AZIMUTH, ANGLE. 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 the feature class used as a template to define the attribute schema of the new turn feature class. if the template feature class has the following fields, they are not created on the output turn feature class; NODE_, NODE#, JUNCTION, F_EDGE, T_EDGE, F-EDGE, T-EDGE, ARC1_,ARC2_,ARC1#,ARC2#,ARC1-ID, ARC2-ID, AZIMUTH, ANGLE. This is an optional parameter.

Parameters:

inTemplateFeatureClass - the feature class used as a template to define the attribute schema of the new turn feature class. if the template feature class has the following fields, they are not created on the output turn feature class; NODE_, NODE#, JUNCTION, F_EDGE, T_EDGE, F-EDGE, T-EDGE, ARC1_,ARC2_,ARC1#,ARC2#,ARC1-ID, ARC2-ID, AZIMUTH, ANGLE.

getSpatialReference

public Object getSpatialReference()

Returns the Spatial Reference parameter of this tool . This parameter is 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 as the output turn feature class will inherit the spatial reference of the feature dataset. if you want to import the spatial reference from an existing feature class, specify its path as the parameter value. 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 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 as the output turn feature class will inherit the spatial reference of the feature dataset. if you want to import the spatial reference from an existing feature class, specify its path as the parameter value. This is an optional parameter.

Parameters:

spatialReference - 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 as the output turn feature class will inherit the spatial reference of the feature dataset. if you want to import the spatial reference from an existing feature class, specify its path as the parameter value.

getConfigKeyword

public String getConfigKeyword()

Returns the Config Keyword parameter of this tool . This parameter is specifies the configuration keyword that determines the storage parameters of the new turn feature class. This parameter is used only if the output location is an ArcSDE geodatabase 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 specifies the configuration keyword that determines the storage parameters of the new turn feature class. This parameter is used only if the output location is an ArcSDE geodatabase This is an optional parameter.

Parameters:

configKeyword - specifies the configuration keyword that determines the storage parameters of the new turn feature class. This parameter is used only if the output location is an ArcSDE geodatabase

getSpatialGrid1

public double getSpatialGrid1()

Returns the Output Spatial Grid 1 parameter of this tool . This parameter is the Spatial Grid 1, 2, and 3 parameters are used to compute a spatial index and only apply to file geodatabases and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. Since no features are written by this tool, the spatial index will be in an unbuilt state. The index will be built when features are written to the feature class such as by the Append tool or editing operations. For more information about this parameter, refer to the Add Spatial Index tool documentation. 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 the Spatial Grid 1, 2, and 3 parameters are used to compute a spatial index and only apply to file geodatabases and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. Since no features are written by this tool, the spatial index will be in an unbuilt state. The index will be built when features are written to the feature class such as by the Append tool or editing operations. For more information about this parameter, refer to the Add Spatial Index tool documentation. This is an optional parameter.

Parameters:

spatialGrid1 - the Spatial Grid 1, 2, and 3 parameters are used to compute a spatial index and only apply to file geodatabases and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. Since no features are written by this tool, the spatial index will be in an unbuilt state. The index will be built when features are written to the feature class such as by the Append tool or editing operations. For more information about this parameter, refer to the Add Spatial Index tool documentation.

getSpatialGrid2

public double getSpatialGrid2()

Returns the Output Spatial Grid 2 parameter of this tool . This parameter is cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. 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 cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. This is an optional parameter.

Parameters:

spatialGrid2 - cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1.

getSpatialGrid3

public double getSpatialGrid3()

Returns the Output Spatial Grid 3 parameter of this tool . This parameter is cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2. 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 cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2. This is an optional parameter.

Parameters:

spatialGrid3 - cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2.

getHasZ

public String getHasZ()

Returns the Has Z parameter of this tool . This is an optional parameter.

Returns:

the Has Z

setHasZ

public void setHasZ(String hasZ)

Sets the Has Z parameter of this tool . This is an optional parameter.

Parameters:

hasZ - null

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