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

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

All Implemented Interfaces:

GPTool

public class PolygonVolume
extends AbstractGPTool

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

Usage tips:

• The input polygons and the TIN or terrain dataset surface 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

PolygonVolume()
Creates the Polygon Volume tool with defaults.

PolygonVolume(Object inSurface, Object inFeatureClass, String inHeightField)
Creates the 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	getInSurface() Returns the Input Surface 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 .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution 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	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setOutVolumeField(String outVolumeField) Sets the Volume Field parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution 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

PolygonVolume

public PolygonVolume()

Creates the Polygon Volume tool with defaults.

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

PolygonVolume

public PolygonVolume(Object inSurface,
                     Object inFeatureClass,
                     String inHeightField)

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

inSurface - the input Terrain dataset or TIN surface.

inFeatureClass - the input polygon feature class.

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

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.

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.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the 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 Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the 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:

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

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