com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class TinLine

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.TinLine

All Implemented Interfaces:

GPTool

public class TinLine

extends AbstractGPTool

Writes the hard and soft breaklines from a TIN into a new 3-D polyline feature class. The TIN Line tool is contained in the 3D Analyst Tools tool box.
Learn more about how TIN Line (3D Analyst) works

Software restrictions: none

Illustration:

Usage tips:

• The input TIN must have some breaklines in order for this tool to produce output line features.
• If you want to convert TIN edges into line features, regardless of whether or not they belong to breaklines, use the TIN Edge tool;

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

TinLine()
Creates the TIN Line tool with defaults.

TinLine(java.lang.Object inTin, java.lang.Object outFeatureClass)
Creates the TIN Line tool with the required parameters.

Method Summary

java.lang.String	getCodeField() Returns the Code Field parameter of this tool .
java.lang.Object	getInTin() Returns the Input TIN parameter of this tool .
java.lang.Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setCodeField(java.lang.String codeField) Sets the Code Field parameter of this tool .
void	setInTin(java.lang.Object inTin) Sets the Input TIN parameter of this tool .
void	setOutFeatureClass(java.lang.Object outFeatureClass) Sets the Output Feature Class 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

TinLine

public TinLine()

Creates the TIN Line tool with defaults.

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

TinLine

public TinLine(java.lang.Object inTin,
               java.lang.Object outFeatureClass)

Creates the TIN Line 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:

inTin - Tin Layer, the input TIN.

outFeatureClass - Feature Class, the output feature class.

Method Detail

getInTin

public java.lang.Object getInTin()

Returns the Input TIN parameter of this tool . This parameter is Tin Layer, the input TIN. This is a required parameter.

Returns:

the Input TIN

setInTin

public void setInTin(java.lang.Object inTin)

Sets the Input TIN parameter of this tool . This parameter is Tin Layer, the input TIN. This is a required parameter.

Parameters:

inTin - Tin Layer, the input TIN.

getOutFeatureClass

public java.lang.Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(java.lang.Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class. This is a required parameter.

Parameters:

outFeatureClass - Feature Class, the output feature class.

getCodeField

public java.lang.String getCodeField()

Returns the Code Field parameter of this tool . This parameter is String, the name of the field added to the output feature class that will contain the breakline type codes. The default is Code. This is an optional parameter.

Returns:

the Code Field

setCodeField

public void setCodeField(java.lang.String codeField)

Sets the Code Field parameter of this tool . This parameter is String, the name of the field added to the output feature class that will contain the breakline type codes. The default is Code. This is an optional parameter.

Parameters:

codeField - String, the name of the field added to the output feature class that will contain the breakline type codes. The default is Code.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias