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

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

All Implemented Interfaces:

GPTool

public class TinNode
extends AbstractGPTool

This tool extracts nodes from an input TIN into an output feature class and produces a 2D or 3D point feature class whose points are extracted from nodes of the input TIN. The TIN Node tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Indicate a Spot Field value to create a 2D feature class.
• Omit Spot Field to create a 3D feature class.

Field Summary

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

vals

Constructor Summary

TinNode()
Creates the TIN Node tool with defaults.

TinNode(Object inTin, Object outFeatureClass)
Creates the TIN Node tool with the required parameters.

Method Summary

Object	getInTin() Returns the Input TIN parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getSpotField() Returns the Spot Field parameter of this tool .
String	getTagField() Returns the Tag Value Field 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	setInTin(Object inTin) Sets the Input TIN parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setSpotField(String spotField) Sets the Spot Field parameter of this tool .
void	setTagField(String tagField) Sets the Tag Value Field 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

TinNode

public TinNode()

Creates the TIN Node tool with defaults.

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

TinNode

public TinNode(Object inTin,
               Object outFeatureClass)

Creates the TIN Node 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 - the input TIN.

outFeatureClass - the output feature class name.

Method Detail

getInTin

public Object getInTin()

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

Returns:

the Input TIN

setInTin

public void setInTin(Object inTin)

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

Parameters:

inTin - the input TIN.

getOutFeatureClass

public Object getOutFeatureClass()

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

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

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

Parameters:

outFeatureClass - the output feature class name.

getSpotField

public String getSpotField()

Returns the Spot Field parameter of this tool . This parameter is the name of the elevation attribute field of the output feature class. If a name is given, the feature class will be 2D; otherwise, it will be 3D. By default, the feature class is 3D. This is an optional parameter.

Returns:

the Spot Field

setSpotField

public void setSpotField(String spotField)

Sets the Spot Field parameter of this tool . This parameter is the name of the elevation attribute field of the output feature class. If a name is given, the feature class will be 2D; otherwise, it will be 3D. By default, the feature class is 3D. This is an optional parameter.

Parameters:

spotField - the name of the elevation attribute field of the output feature class. If a name is given, the feature class will be 2D; otherwise, it will be 3D. By default, the feature class is 3D.

getTagField

public String getTagField()

Returns the Tag Value Field parameter of this tool . This parameter is the name of the output feature class's tag attribute field. By default, no tag value field is created. This is an optional parameter.

Returns:

the Tag Value Field

setTagField

public void setTagField(String tagField)

Sets the Tag Value Field parameter of this tool . This parameter is the name of the output feature class's tag attribute field. By default, no tag value field is created. This is an optional parameter.

Parameters:

tagField - the name of the output feature class's tag attribute field. By default, no tag value field is created.

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