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

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

public class CutFill
extends AbstractGPTool

Calculates the volume and area of cut and fill locations. The Cut/Fill tool is contained in the 3D Analyst Tools tool box.
Learn more about how Cut/Fill works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CutFill()
          Creates the Cut/Fill tool with defaults.
CutFill(Object inBeforeSurface, Object inAfterSurface, Object outRaster)
          Creates the Cut/Fill tool with the required parameters.
 
Method Summary
 Object getInAfterSurface()
          Returns the Input after raster surface parameter of this tool .
 Object getInBeforeSurface()
          Returns the Input before raster surface parameter of this tool .
 Object getOutRaster()
          Returns the Output raster 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.
 double getZFactor()
          Returns the Z factor parameter of this tool .
 void setInAfterSurface(Object inAfterSurface)
          Sets the Input after raster surface parameter of this tool .
 void setInBeforeSurface(Object inBeforeSurface)
          Sets the Input before raster surface parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setZFactor(double zFactor)
          Sets the Z factor 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

CutFill

public CutFill()
Creates the Cut/Fill tool with defaults.

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


CutFill

public CutFill(Object inBeforeSurface,
               Object inAfterSurface,
               Object outRaster)
Creates the Cut/Fill 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:
inBeforeSurface - Composite Geodataset, input before surface.
inAfterSurface - Composite Geodataset, input after surface.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInBeforeSurface

public Object getInBeforeSurface()
Returns the Input before raster surface parameter of this tool . This parameter is Composite Geodataset, input before surface. This is a required parameter.

Returns:
the Input before raster surface

setInBeforeSurface

public void setInBeforeSurface(Object inBeforeSurface)
Sets the Input before raster surface parameter of this tool . This parameter is Composite Geodataset, input before surface. This is a required parameter.

Parameters:
inBeforeSurface - Composite Geodataset, input before surface.

getInAfterSurface

public Object getInAfterSurface()
Returns the Input after raster surface parameter of this tool . This parameter is Composite Geodataset, input after surface. This is a required parameter.

Returns:
the Input after raster surface

setInAfterSurface

public void setInAfterSurface(Object inAfterSurface)
Sets the Input after raster surface parameter of this tool . This parameter is Composite Geodataset, input after surface. This is a required parameter.

Parameters:
inAfterSurface - Composite Geodataset, input after surface.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:
the Output raster

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the raster to be created.

getZFactor

public double getZFactor()
Returns the Z factor parameter of this tool . This parameter is Double, for example, if your z units are feet, and your x, y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). This is an optional parameter.

Returns:
the Z factor

setZFactor

public void setZFactor(double zFactor)
Sets the Z factor parameter of this tool . This parameter is Double, for example, if your z units are feet, and your x, y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). This is an optional parameter.

Parameters:
zFactor - Double, for example, if your z units are feet, and your x, y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter).

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