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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analyst3dtools.TinDifference
All Implemented Interfaces:
GPTool

public class TinDifference
extends AbstractGPTool

Calculates the volumetric difference between two TINs. The TIN Difference tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
TinDifference()
          Creates the TIN Difference tool with defaults.
TinDifference(java.lang.Object inTin1, java.lang.Object inTin2, java.lang.Object outFeatureClass)
          Creates the TIN Difference tool with the required parameters.
 
Method Summary
 java.lang.Object getInTin1()
          Returns the Input TIN parameter of this tool .
 java.lang.Object getInTin2()
          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 setInTin1(java.lang.Object inTin1)
          Sets the Input TIN parameter of this tool .
 void setInTin2(java.lang.Object inTin2)
          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

TinDifference

public TinDifference()
Creates the TIN Difference tool with defaults.

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


TinDifference

public TinDifference(java.lang.Object inTin1,
                     java.lang.Object inTin2,
                     java.lang.Object outFeatureClass)
Creates the TIN Difference 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:
inTin1 - the first input TIN.
inTin2 - the second input TIN.
outFeatureClass - the output polygon feature class.
Method Detail

getInTin1

public java.lang.Object getInTin1()
Returns the Input TIN parameter of this tool . This parameter is the first input TIN. This is a required parameter.

Returns:
the Input TIN

setInTin1

public void setInTin1(java.lang.Object inTin1)
Sets the Input TIN parameter of this tool . This parameter is the first input TIN. This is a required parameter.

Parameters:
inTin1 - the first input TIN.

getInTin2

public java.lang.Object getInTin2()
Returns the Input TIN parameter of this tool . This parameter is the second input TIN. This is a required parameter.

Returns:
the Input TIN

setInTin2

public void setInTin2(java.lang.Object inTin2)
Sets the Input TIN parameter of this tool . This parameter is the second input TIN. This is a required parameter.

Parameters:
inTin2 - the second input TIN.

getOutFeatureClass

public java.lang.Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the output polygon 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 the output polygon feature class. This is a required parameter.

Parameters:
outFeatureClass - the output polygon feature class.

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