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

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

All Implemented Interfaces:

GPTool

public class TinPolygonTag
extends AbstractGPTool

Extracts polygons with tag information from an input TIN into an output feature class. The TIN Polygon Tag tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Polygons will be generated for all TIN triangles that have tag values.
• Produces a polygon feature class whose polygons are categorized by the input TIN's triangle tag values.

Field Summary

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

vals

Constructor Summary

TinPolygonTag()
Creates the TIN Polygon Tag tool with defaults.

TinPolygonTag(Object inTin, Object outFeatureClass)
Creates the TIN Polygon Tag 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	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	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

TinPolygonTag

public TinPolygonTag()

Creates the TIN Polygon Tag tool with defaults.

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

TinPolygonTag

public TinPolygonTag(Object inTin,
                     Object outFeatureClass)

Creates the TIN Polygon Tag 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.

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. 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. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getTagField

public String getTagField()

Returns the Tag Value Field parameter of this tool . This parameter is the name of the output feature class tag attribute field. By default, the field name is "Tag_Value". 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 tag attribute field. By default, the field name is "Tag_Value". This is an optional parameter.

Parameters:

tagField - the name of the output feature class tag attribute field. By default, the field name is "Tag_Value".

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