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

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

public class ContourWithBarriers
extends AbstractGPTool

Creates contours from a raster surface. The inclusion of barrier features will allow one to independently generate contours on either side of a barrier. The Contour with Barriers tool is contained in the 3D Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ContourWithBarriers()
          Creates the Contour with Barriers tool with defaults.
ContourWithBarriers(Object inRaster, Object outContourFeatureClass)
          Creates the Contour with Barriers tool with the required parameters.
 
Method Summary
 String getExplicitOnly()
          Returns the Enter Explicit Contour Values Only parameter of this tool .
 Object getInBarrierFeatures()
          Returns the Input Barrier Features parameter of this tool .
 double getInBaseContour()
          Returns the Base Contour parameter of this tool .
 double getInContourInterval()
          Returns the Contour Interval parameter of this tool .
 Object getInContourList()
          Returns the Explicit Contour Values parameter of this tool .
 String getInContourType()
          Returns the Type of Contours parameter of this tool .
 Object getInContourValuesFile()
          Returns the File Containing Contour Value Specifications parameter of this tool .
 double getInIndexedContourInterval()
          Returns the Indexed Contour Interval parameter of this tool .
 Object getInRaster()
          Returns the Input Raster parameter of this tool .
 double getInZFactor()
          Returns the Factor Applied to Raster Z-values parameter of this tool .
 Object getOutContourFeatureClass()
          Returns the Output Contour 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 setExplicitOnly(String explicitOnly)
          Sets the Enter Explicit Contour Values Only parameter of this tool .
 void setInBarrierFeatures(Object inBarrierFeatures)
          Sets the Input Barrier Features parameter of this tool .
 void setInBaseContour(double inBaseContour)
          Sets the Base Contour parameter of this tool .
 void setInContourInterval(double inContourInterval)
          Sets the Contour Interval parameter of this tool .
 void setInContourList(Object inContourList)
          Sets the Explicit Contour Values parameter of this tool .
 void setInContourType(String inContourType)
          Sets the Type of Contours parameter of this tool .
 void setInContourValuesFile(Object inContourValuesFile)
          Sets the File Containing Contour Value Specifications parameter of this tool .
 void setInIndexedContourInterval(double inIndexedContourInterval)
          Sets the Indexed Contour Interval parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input Raster parameter of this tool .
 void setInZFactor(double inZFactor)
          Sets the Factor Applied to Raster Z-values parameter of this tool .
 void setOutContourFeatureClass(Object outContourFeatureClass)
          Sets the Output Contour 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

ContourWithBarriers

public ContourWithBarriers()
Creates the Contour with Barriers tool with defaults.

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


ContourWithBarriers

public ContourWithBarriers(Object inRaster,
                           Object outContourFeatureClass)
Creates the Contour with Barriers 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.
outContourFeatureClass - Feature Class, output contour features.
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.

getOutContourFeatureClass

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

Returns:
the Output Contour Features

setOutContourFeatureClass

public void setOutContourFeatureClass(Object outContourFeatureClass)
Sets the Output Contour Features parameter of this tool . This parameter is Feature Class, output contour features. This is a required parameter.

Parameters:
outContourFeatureClass - Feature Class, output contour features.

getInBarrierFeatures

public Object getInBarrierFeatures()
Returns the Input Barrier Features parameter of this tool . This parameter is Feature Class, input barrier features. This is an optional parameter.

Returns:
the Input Barrier Features

setInBarrierFeatures

public void setInBarrierFeatures(Object inBarrierFeatures)
Sets the Input Barrier Features parameter of this tool . This parameter is Feature Class, input barrier features. This is an optional parameter.

Parameters:
inBarrierFeatures - Feature Class, input barrier features.

getInContourType

public String getInContourType()
Returns the Type of Contours parameter of this tool . This parameter is Double, the current version of Contour with Barriers only supports polyline output. If the polygon output option is used it will be ignored and polyline output will be created. This is an optional parameter.

Returns:
the Type of Contours

setInContourType

public void setInContourType(String inContourType)
Sets the Type of Contours parameter of this tool . This parameter is Double, the current version of Contour with Barriers only supports polyline output. If the polygon output option is used it will be ignored and polyline output will be created. This is an optional parameter.

Parameters:
inContourType - Double, the current version of Contour with Barriers only supports polyline output. If the polygon output option is used it will be ignored and polyline output will be created.

getInContourValuesFile

public Object getInContourValuesFile()
Returns the File Containing Contour Value Specifications parameter of this tool . This parameter is file, the base contour, contour interval, indexed contour interval and explicit contour values can also be specified via a text file. This is an optional parameter.

Returns:
the File Containing Contour Value Specifications

setInContourValuesFile

public void setInContourValuesFile(Object inContourValuesFile)
Sets the File Containing Contour Value Specifications parameter of this tool . This parameter is file, the base contour, contour interval, indexed contour interval and explicit contour values can also be specified via a text file. This is an optional parameter.

Parameters:
inContourValuesFile - file, the base contour, contour interval, indexed contour interval and explicit contour values can also be specified via a text file.

getExplicitOnly

public String getExplicitOnly()
Returns the Enter Explicit Contour Values Only parameter of this tool . This parameter is , only explicit contour values are used. Base contour, contour interval and indexed contour intervals are not specified. This is an optional parameter.

Returns:
the Enter Explicit Contour Values Only

setExplicitOnly

public void setExplicitOnly(String explicitOnly)
Sets the Enter Explicit Contour Values Only parameter of this tool . This parameter is , only explicit contour values are used. Base contour, contour interval and indexed contour intervals are not specified. This is an optional parameter.

Parameters:
explicitOnly - , only explicit contour values are used. Base contour, contour interval and indexed contour intervals are not specified.

getInBaseContour

public double getInBaseContour()
Returns the Base Contour parameter of this tool . This parameter is Double, contours are generated above and below this value as needed to cover the entire value range of the input raster. The default is zero. This is an optional parameter.

Returns:
the Base Contour

setInBaseContour

public void setInBaseContour(double inBaseContour)
Sets the Base Contour parameter of this tool . This parameter is Double, contours are generated above and below this value as needed to cover the entire value range of the input raster. The default is zero. This is an optional parameter.

Parameters:
inBaseContour - Double, contours are generated above and below this value as needed to cover the entire value range of the input raster. The default is zero.

getInContourInterval

public double getInContourInterval()
Returns the Contour Interval parameter of this tool . This parameter is Double, this can be any positive number. This is an optional parameter.

Returns:
the Contour Interval

setInContourInterval

public void setInContourInterval(double inContourInterval)
Sets the Contour Interval parameter of this tool . This parameter is Double, this can be any positive number. This is an optional parameter.

Parameters:
inContourInterval - Double, this can be any positive number.

getInIndexedContourInterval

public double getInIndexedContourInterval()
Returns the Indexed Contour Interval parameter of this tool . This parameter is Double, contours will also be generated for this interval and will be flagged accordingly in the output feature class. This is an optional parameter.

Returns:
the Indexed Contour Interval

setInIndexedContourInterval

public void setInIndexedContourInterval(double inIndexedContourInterval)
Sets the Indexed Contour Interval parameter of this tool . This parameter is Double, contours will also be generated for this interval and will be flagged accordingly in the output feature class. This is an optional parameter.

Parameters:
inIndexedContourInterval - Double, contours will also be generated for this interval and will be flagged accordingly in the output feature class.

getInContourList

public Object getInContourList()
Returns the Explicit Contour Values parameter of this tool . This parameter is Double, explicit values at which to create contours. This is an optional parameter.

Returns:
the Explicit Contour Values

setInContourList

public void setInContourList(Object inContourList)
Sets the Explicit Contour Values parameter of this tool . This parameter is Double, explicit values at which to create contours. This is an optional parameter.

Parameters:
inContourList - Double, explicit values at which to create contours.

getInZFactor

public double getInZFactor()
Returns the Factor Applied to Raster Z-values parameter of this tool . This parameter is Double, multiplication factor. For example your z units are feet and your contours should be in 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 Factor Applied to Raster Z-values

setInZFactor

public void setInZFactor(double inZFactor)
Sets the Factor Applied to Raster Z-values parameter of this tool . This parameter is Double, multiplication factor. For example your z units are feet and your contours should be in 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:
inZFactor - Double, multiplication factor. For example your z units are feet and your contours should be in 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