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

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

All Implemented Interfaces:

GPTool

public class SurfaceDifference
extends AbstractGPTool

This tool calculates the volumetric difference between two triangulated irregular networks (TIN), or terrain datasets. The Surface Difference tool is contained in the 3D Analyst Tools tool box.

Field Summary

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

vals

Constructor Summary

SurfaceDifference()
Creates the Surface Difference tool with defaults.

SurfaceDifference(Object inSurface, Object inReferenceSurface, Object outFeatureClass)
Creates the Surface Difference tool with the required parameters.

Method Summary

Object	getInReferenceSurface() Returns the Input Reference Surface parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getOutRaster() Returns the Output Raster parameter of this tool .
String	getOutTinBasename() Returns the Output TIN base name parameter of this tool .
Object	getOutTinFolder() Returns the Output TIN folder parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
double	getRasterCellSize() Returns the Raster Cell Size parameter of this tool .
double	getReferencePyramidLevelResolution() Returns the Reference Surface Pyramid Level Resolution 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	setInReferenceSurface(Object inReferenceSurface) Sets the Input Reference Surface parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output Raster parameter of this tool .
void	setOutTinBasename(String outTinBasename) Sets the Output TIN base name parameter of this tool .
void	setOutTinFolder(Object outTinFolder) Sets the Output TIN folder parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setRasterCellSize(double rasterCellSize) Sets the Raster Cell Size parameter of this tool .
void	setReferencePyramidLevelResolution(double referencePyramidLevelResolution) Sets the Reference Surface Pyramid Level Resolution 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

SurfaceDifference

public SurfaceDifference()

Creates the Surface Difference tool with defaults.

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

SurfaceDifference

public SurfaceDifference(Object inSurface,
                         Object inReferenceSurface,
                         Object outFeatureClass)

Creates the Surface 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:

inSurface - the input terrain dataset or TIN surface.

inReferenceSurface - the reference TIN or terrain dataset.

outFeatureClass - the output polygon feature class.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the input terrain dataset or TIN surface. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is the input terrain dataset or TIN surface. This is a required parameter.

Parameters:

inSurface - the input terrain dataset or TIN surface.

getInReferenceSurface

public Object getInReferenceSurface()

Returns the Input Reference Surface parameter of this tool . This parameter is the reference TIN or terrain dataset. This is a required parameter.

Returns:

the Input Reference Surface

setInReferenceSurface

public void setInReferenceSurface(Object inReferenceSurface)

Sets the Input Reference Surface parameter of this tool . This parameter is the reference TIN or terrain dataset. This is a required parameter.

Parameters:

inReferenceSurface - the reference TIN or terrain dataset.

getOutFeatureClass

public 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(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.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for the regular terrain dataset. The default is 0, full resolution. This is an optional parameter.

Returns:

the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for the regular terrain dataset. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the resolution of the terrain dataset pyramid level to use for the regular terrain dataset. The default is 0, full resolution.

getReferencePyramidLevelResolution

public double getReferencePyramidLevelResolution()

Returns the Reference Surface Pyramid Level Resolution parameter of this tool . This parameter is the pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution. This is an optional parameter.

Returns:

the Reference Surface Pyramid Level Resolution

setReferencePyramidLevelResolution

public void setReferencePyramidLevelResolution(double referencePyramidLevelResolution)

Sets the Reference Surface Pyramid Level Resolution parameter of this tool . This parameter is the pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution. This is an optional parameter.

Parameters:

referencePyramidLevelResolution - the pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution.

getOutRaster

public Object getOutRaster()

Returns the Output Raster parameter of this tool . This parameter is the output raster dataset. This is an optional parameter.

Returns:

the Output Raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output Raster parameter of this tool . This parameter is the output raster dataset. This is an optional parameter.

Parameters:

outRaster - the output raster dataset.

getRasterCellSize

public double getRasterCellSize()

Returns the Raster Cell Size parameter of this tool . This parameter is the cell size of the output raster dataset. This is an optional parameter.

Returns:

the Raster Cell Size

setRasterCellSize

public void setRasterCellSize(double rasterCellSize)

Sets the Raster Cell Size parameter of this tool . This parameter is the cell size of the output raster dataset. This is an optional parameter.

Parameters:

rasterCellSize - the cell size of the output raster dataset.

getOutTinFolder

public Object getOutTinFolder()

Returns the Output TIN folder parameter of this tool . This parameter is the folder location to write the TIN or TINs. This is an optional parameter.

Returns:

the Output TIN folder

setOutTinFolder

public void setOutTinFolder(Object outTinFolder)

Sets the Output TIN folder parameter of this tool . This parameter is the folder location to write the TIN or TINs. This is an optional parameter.

Parameters:

outTinFolder - the folder location to write the TIN or TINs.

getOutTinBasename

public String getOutTinBasename()

Returns the Output TIN base name parameter of this tool . This parameter is the base name given to each output TIN surface. This is an optional parameter.

Returns:

the Output TIN base name

setOutTinBasename

public void setOutTinBasename(String outTinBasename)

Sets the Output TIN base name parameter of this tool . This parameter is the base name given to each output TIN surface. This is an optional parameter.

Parameters:

outTinBasename - the base name given to each output TIN surface.

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