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

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

public class ContourList
extends AbstractGPTool

Creates contours or isolines based on a list of contour values. The Contour List tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Contour List works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ContourList()
          Creates the Contour List tool with defaults.
ContourList(Object inRaster, Object outPolylineFeatures, Object contourValues)
          Creates the Contour List tool with the required parameters.
 
Method Summary
 Object getContourValues()
          Returns the Contour values parameter of this tool .
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 Object getOutPolylineFeatures()
          Returns the Output polyline features 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 setContourValues(Object contourValues)
          Sets the Contour values parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setOutPolylineFeatures(Object outPolylineFeatures)
          Sets the Output polyline features 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

ContourList

public ContourList()
Creates the Contour List tool with defaults.

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


ContourList

public ContourList(Object inRaster,
                   Object outPolylineFeatures,
                   Object contourValues)
Creates the Contour List 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:
inRaster - Composite Geodataset, input raster.
outPolylineFeatures - Feature Class, output contour polyline features.
contourValues - Double, list of z-values for which to create contours.
Method Detail

getInRaster

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

Returns:
the Input raster

setInRaster

public void setInRaster(Object inRaster)
Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, input raster.

getOutPolylineFeatures

public Object getOutPolylineFeatures()
Returns the Output polyline features parameter of this tool . This parameter is Feature Class, output contour polyline features. This is a required parameter.

Returns:
the Output polyline features

setOutPolylineFeatures

public void setOutPolylineFeatures(Object outPolylineFeatures)
Sets the Output polyline features parameter of this tool . This parameter is Feature Class, output contour polyline features. This is a required parameter.

Parameters:
outPolylineFeatures - Feature Class, output contour polyline features.

getContourValues

public Object getContourValues()
Returns the Contour values parameter of this tool . This parameter is Double, list of z-values for which to create contours. This is a required parameter.

Returns:
the Contour values

setContourValues

public void setContourValues(Object contourValues)
Sets the Contour values parameter of this tool . This parameter is Double, list of z-values for which to create contours. This is a required parameter.

Parameters:
contourValues - Double, list of z-values for which to create contours.

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