com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class TINCompare

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.TINCompare

All Implemented Interfaces:

GPTool

public class TINCompare
extends AbstractGPTool

Compares two TINs and returns the comparison results. TIN Compare can report differences with geometry, TIN node and triangle tags, and spatial reference. The TIN Compare tool is contained in the Data Management Tools tool box.

Usage tips:

• The tool returns messages showing the comparison result. By default, the tool will stop executing after encountering the first miscompare. To report all differences, set the continue compare option to true.
• The Output Compare File will contain all similarities and differences between the Input Base TIN and the Input Test TIN. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS. For example, this table can be queried to obtain all the ObjectID values for all the rows that are different.
• The comparison tools will be 'true' when no differences are found and 'false' when differences are detected.

Field Summary

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

vals

Constructor Summary

TINCompare()
Creates the TIN Compare tool with defaults.

TINCompare(Object inBaseTin, Object inTestTin)
Creates the TIN Compare tool with the required parameters.

Method Summary

String	getCompareStatus() Returns the Compare Status parameter of this tool (Read only).
String	getCompareType() Returns the Compare Type parameter of this tool .
String	getContinueCompare() Returns the Continue Comparison parameter of this tool .
Object	getInBaseTin() Returns the Input Base Tin parameter of this tool .
Object	getInTestTin() Returns the Input Test Tin parameter of this tool .
Object	getOutCompareFile() Returns the Output Compare File 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	setCompareType(String compareType) Sets the Compare Type parameter of this tool .
void	setContinueCompare(String continueCompare) Sets the Continue Comparison parameter of this tool .
void	setInBaseTin(Object inBaseTin) Sets the Input Base Tin parameter of this tool .
void	setInTestTin(Object inTestTin) Sets the Input Test Tin parameter of this tool .
void	setOutCompareFile(Object outCompareFile) Sets the Output Compare File 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

TINCompare

public TINCompare()

Creates the TIN Compare tool with defaults.

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

TINCompare

public TINCompare(Object inBaseTin,
                  Object inTestTin)

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

inBaseTin - the Input Base Tin is compared with the Input Test Tin. Input Base Tin refers to data that you have declared valid. This base data has the correct geometry, tag values (if any), and spatial reference.

inTestTin - the Input Test Tin is compared against the Input Base Tin.

Method Detail

getInBaseTin

public Object getInBaseTin()

Returns the Input Base Tin parameter of this tool . This parameter is the Input Base Tin is compared with the Input Test Tin. Input Base Tin refers to data that you have declared valid. This base data has the correct geometry, tag values (if any), and spatial reference. This is a required parameter.

Returns:

the Input Base Tin

setInBaseTin

public void setInBaseTin(Object inBaseTin)

Sets the Input Base Tin parameter of this tool . This parameter is the Input Base Tin is compared with the Input Test Tin. Input Base Tin refers to data that you have declared valid. This base data has the correct geometry, tag values (if any), and spatial reference. This is a required parameter.

Parameters:

inBaseTin - the Input Base Tin is compared with the Input Test Tin. Input Base Tin refers to data that you have declared valid. This base data has the correct geometry, tag values (if any), and spatial reference.

getInTestTin

public Object getInTestTin()

Returns the Input Test Tin parameter of this tool . This parameter is the Input Test Tin is compared against the Input Base Tin. This is a required parameter.

Returns:

the Input Test Tin

setInTestTin

public void setInTestTin(Object inTestTin)

Sets the Input Test Tin parameter of this tool . This parameter is the Input Test Tin is compared against the Input Base Tin. This is a required parameter.

Parameters:

inTestTin - the Input Test Tin is compared against the Input Base Tin.

getCompareType

public String getCompareType()

Returns the Compare Type parameter of this tool . This parameter is the comparison type. This is an optional parameter.

Returns:

the Compare Type

setCompareType

public void setCompareType(String compareType)

Sets the Compare Type parameter of this tool . This parameter is the comparison type. This is an optional parameter.

Parameters:

compareType - the comparison type.

getContinueCompare

public String getContinueCompare()

Returns the Continue Comparison parameter of this tool . This parameter is indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Returns:

the Continue Comparison

setContinueCompare

public void setContinueCompare(String continueCompare)

Sets the Continue Comparison parameter of this tool . This parameter is indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Parameters:

continueCompare - indicates whether to compare all properties after encountering the first mismatch.

getOutCompareFile

public Object getOutCompareFile()

Returns the Output Compare File parameter of this tool . This parameter is the name and path of the text file which will contain the comparison results. This is an optional parameter.

Returns:

the Output Compare File

setOutCompareFile

public void setOutCompareFile(Object outCompareFile)

Sets the Output Compare File parameter of this tool . This parameter is the name and path of the text file which will contain the comparison results. This is an optional parameter.

Parameters:

outCompareFile - the name and path of the text file which will contain the comparison results.

getCompareStatus

public String getCompareStatus()

Returns the Compare Status parameter of this tool (Read only). This is an derived parameter.

Returns:

the Compare Status

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