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

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

public class CutFill
extends AbstractGPTool

Calculates the volume change between two surfaces. This is typically used for cut and fill operations. The Cut Fill tool is contained in the Spatial Analyst Tools tool box.

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(java.lang.Object inBeforeSurface, java.lang.Object inAfterSurface, java.lang.Object outRaster)
          Creates the Cut Fill tool with the required parameters.
 
Method Summary
 java.lang.Object getInAfterSurface()
          Returns the Input after raster surface parameter of this tool .
 java.lang.Object getInBeforeSurface()
          Returns the Input before raster surface parameter of this tool .
 java.lang.Object getOutRaster()
          Returns the Output raster parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 double getZFactor()
          Returns the Z factor parameter of this tool .
 void setInAfterSurface(java.lang.Object inAfterSurface)
          Sets the Input after raster surface parameter of this tool .
 void setInBeforeSurface(java.lang.Object inBeforeSurface)
          Sets the Input before raster surface parameter of this tool .
 void setOutRaster(java.lang.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(java.lang.Object inBeforeSurface,
               java.lang.Object inAfterSurface,
               java.lang.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 - the input representing the surface before the cut or fill operation.
inAfterSurface - the input representing the surface after the cut or fill operation.
outRaster - the output raster defining regions of cut and of fill. the values show the locations and amounts where the surface has been added to or removed from.
Method Detail

getInBeforeSurface

public java.lang.Object getInBeforeSurface()
Returns the Input before raster surface parameter of this tool . This parameter is the input representing the surface before the cut or fill operation. This is a required parameter.

Returns:
the Input before raster surface

setInBeforeSurface

public void setInBeforeSurface(java.lang.Object inBeforeSurface)
Sets the Input before raster surface parameter of this tool . This parameter is the input representing the surface before the cut or fill operation. This is a required parameter.

Parameters:
inBeforeSurface - the input representing the surface before the cut or fill operation.

getInAfterSurface

public java.lang.Object getInAfterSurface()
Returns the Input after raster surface parameter of this tool . This parameter is the input representing the surface after the cut or fill operation. This is a required parameter.

Returns:
the Input after raster surface

setInAfterSurface

public void setInAfterSurface(java.lang.Object inAfterSurface)
Sets the Input after raster surface parameter of this tool . This parameter is the input representing the surface after the cut or fill operation. This is a required parameter.

Parameters:
inAfterSurface - the input representing the surface after the cut or fill operation.

getOutRaster

public java.lang.Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output raster defining regions of cut and of fill. the values show the locations and amounts where the surface has been added to or removed from. This is a required parameter.

Returns:
the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)
Sets the Output raster parameter of this tool . This parameter is the output raster defining regions of cut and of fill. the values show the locations and amounts where the surface has been added to or removed from. This is a required parameter.

Parameters:
outRaster - the output raster defining regions of cut and of fill. the values show the locations and amounts where the surface has been added to or removed from.

getZFactor

public double getZFactor()
Returns the Z factor parameter of this tool . This parameter is number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. 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 number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. 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 - number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. 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 java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias