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

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

All Implemented Interfaces:

GPTool

public class TinPolygonVolume
extends AbstractGPTool

Calculates the volumetric and surface area between polygons of an input feature class and a TIN surface. The TIN Polygon Volume tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The input polygons and TIN need to overlap in horizontal extent in order for surface area or volume to be calculated.

Field Summary

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

vals

Constructor Summary

TinPolygonVolume()
Creates the TIN Polygon Volume tool with defaults.

TinPolygonVolume(Object inTin, Object inFeatureClass, String inHeightField)
Creates the TIN Polygon Volume tool with the required parameters.

Method Summary

Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
String	getInHeightField() Returns the Height Field parameter of this tool .
Object	getInTin() Returns the Input TIN parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool (Read only).
String	getOutVolumeField() Returns the Volume Field parameter of this tool .
String	getReferencePlane() Returns the Reference Plane parameter of this tool .
String	getSurfaceAreaField() Returns the Surface Area 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	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInHeightField(String inHeightField) Sets the Height Field parameter of this tool .
void	setInTin(Object inTin) Sets the Input TIN parameter of this tool .
void	setOutVolumeField(String outVolumeField) Sets the Volume Field parameter of this tool .
void	setReferencePlane(String referencePlane) Sets the Reference Plane parameter of this tool .
void	setSurfaceAreaField(String surfaceAreaField) Sets the Surface Area 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

TinPolygonVolume

public TinPolygonVolume()

Creates the TIN Polygon Volume tool with defaults.

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

TinPolygonVolume

public TinPolygonVolume(Object inTin,
                        Object inFeatureClass,
                        String inHeightField)

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

inFeatureClass - the input polygon feature class.

inHeightField - the name of the field containing polygon reference plane heights.

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.

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input polygon feature class. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the input polygon feature class. This is a required parameter.

Parameters:

inFeatureClass - the input polygon feature class.

getInHeightField

public String getInHeightField()

Returns the Height Field parameter of this tool . This parameter is the name of the field containing polygon reference plane heights. This is a required parameter.

Returns:

the Height Field

setInHeightField

public void setInHeightField(String inHeightField)

Sets the Height Field parameter of this tool . This parameter is the name of the field containing polygon reference plane heights. This is a required parameter.

Parameters:

inHeightField - the name of the field containing polygon reference plane heights.

getReferencePlane

public String getReferencePlane()

Returns the Reference Plane parameter of this tool . This parameter is the keyword used to indicate whether volume and surface area are calculated ABOVE the reference plane height of the polygons, or BELOW. The default is BELOW. This is an optional parameter.

Returns:

the Reference Plane

setReferencePlane

public void setReferencePlane(String referencePlane)

Sets the Reference Plane parameter of this tool . This parameter is the keyword used to indicate whether volume and surface area are calculated ABOVE the reference plane height of the polygons, or BELOW. The default is BELOW. This is an optional parameter.

Parameters:

referencePlane - the keyword used to indicate whether volume and surface area are calculated ABOVE the reference plane height of the polygons, or BELOW. The default is BELOW.

getOutVolumeField

public String getOutVolumeField()

Returns the Volume Field parameter of this tool . This parameter is the name of the output field used to store the volume result. The default is Volume. This is an optional parameter.

Returns:

the Volume Field

setOutVolumeField

public void setOutVolumeField(String outVolumeField)

Sets the Volume Field parameter of this tool . This parameter is the name of the output field used to store the volume result. The default is Volume. This is an optional parameter.

Parameters:

outVolumeField - the name of the output field used to store the volume result. The default is Volume.

getSurfaceAreaField

public String getSurfaceAreaField()

Returns the Surface Area Field parameter of this tool . This parameter is the name of the output field used to store the surface area result. The default is SArea. This is an optional parameter.

Returns:

the Surface Area Field

setSurfaceAreaField

public void setSurfaceAreaField(String surfaceAreaField)

Sets the Surface Area Field parameter of this tool . This parameter is the name of the output field used to store the surface area result. The default is SArea. This is an optional parameter.

Parameters:

surfaceAreaField - the name of the output field used to store the surface area result. The default is SArea.

getOutputFeatureClass

public Object getOutputFeatureClass()

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

Returns:

the Output Feature Class

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