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

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

All Implemented Interfaces:

GPTool

public class DelineateTinDataArea
extends AbstractGPTool

Defines the data area, or interpolation zone, of a TIN based on triangle edge length. The Delineate TIN Data Area tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• This tool modifies the input TIN. If you prefer not to modify the input, use the standard Copy tool and operate on the copied TIN.
• The value for Maximum Edge Length is best determined from the average spacing of nodes in the TIN within areas that are considered valid data zones. Provide a value that is larger than the average spacing.

Field Summary

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

vals

Constructor Summary

DelineateTinDataArea()
Creates the Delineate TIN Data Area tool with defaults.

DelineateTinDataArea(Object inTin, double maxEdgeLength)
Creates the Delineate TIN Data Area tool with the required parameters.

Method Summary

Object	getDerivedOutTin() Returns the Output TIN parameter of this tool (Read only).
Object	getInTin() Returns the Input TIN parameter of this tool .
double	getMaxEdgeLength() Returns the Maximum Edge Length parameter of this tool .
String	getMethod() Returns the Method 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	setMaxEdgeLength(double maxEdgeLength) Sets the Maximum Edge Length parameter of this tool .
void	setMethod(String method) Sets the Method 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

DelineateTinDataArea

public DelineateTinDataArea()

Creates the Delineate TIN Data Area tool with defaults.

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

DelineateTinDataArea

public DelineateTinDataArea(Object inTin,
                            double maxEdgeLength)

Creates the Delineate TIN Data Area 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.

maxEdgeLength - triangles with at least one edge that exceeds will be masked out as NODATA. These triangles will not be rendered in maps and will not be used in surface analysis such as interpolation. Length is the 2D distance.

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.

getMaxEdgeLength

public double getMaxEdgeLength()

Returns the Maximum Edge Length parameter of this tool . This parameter is triangles with at least one edge that exceeds will be masked out as NODATA. These triangles will not be rendered in maps and will not be used in surface analysis such as interpolation. Length is the 2D distance. This is a required parameter.

Returns:

the Maximum Edge Length

setMaxEdgeLength

public void setMaxEdgeLength(double maxEdgeLength)

Sets the Maximum Edge Length parameter of this tool . This parameter is triangles with at least one edge that exceeds will be masked out as NODATA. These triangles will not be rendered in maps and will not be used in surface analysis such as interpolation. Length is the 2D distance. This is a required parameter.

Parameters:

maxEdgeLength - triangles with at least one edge that exceeds will be masked out as NODATA. These triangles will not be rendered in maps and will not be used in surface analysis such as interpolation. Length is the 2D distance.

getMethod

public String getMethod()

Returns the Method parameter of this tool . This parameter is the method used when processing triangles. PERIMETER_ONLY will iterate through triangles from the TIN's outer extent inward and will stop when the current iteration of boundary triangle edges don't exceed the Maximum Edge Length. ALL will classify the entire collection of TIN triangles by edge length. The default is PERIMETER_ONLY. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(String method)

Sets the Method parameter of this tool . This parameter is the method used when processing triangles. PERIMETER_ONLY will iterate through triangles from the TIN's outer extent inward and will stop when the current iteration of boundary triangle edges don't exceed the Maximum Edge Length. ALL will classify the entire collection of TIN triangles by edge length. The default is PERIMETER_ONLY. This is an optional parameter.

Parameters:

method - the method used when processing triangles. PERIMETER_ONLY will iterate through triangles from the TIN's outer extent inward and will stop when the current iteration of boundary triangle edges don't exceed the Maximum Edge Length. ALL will classify the entire collection of TIN triangles by edge length. The default is PERIMETER_ONLY.

getDerivedOutTin

public Object getDerivedOutTin()

Returns the Output TIN parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output TIN

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