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

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

All Implemented Interfaces:

GPTool

public class SurfaceContour
extends AbstractGPTool

Creates a feature class containing a set of contours generated from a terrain dataset or TIN surface. The output feature class is 2D and contains an attribute with contour values. The Surface Contour tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Use the interval and base contour options to tailor the extent and resolution of the output feature class.
• Use the out contour field data to convert the feature class to 3D.
• In certain instances the last valid contour line may not be produced when creating contours using TIN surfaces. This is an algorithmic limitation common to computer contouring software. To ensure that all valid contours are generated, add a very small negative value to the base contour field to slightly shift the data.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SurfaceContour()
Creates the Surface Contour tool with defaults.

SurfaceContour(Object inSurface, Object outFeatureClass, double interval)
Creates the Surface Contour tool with the required parameters.

Method Summary

double	getBaseContour() Returns the Base Contour parameter of this tool .
String	getContourField() Returns the Contour Field parameter of this tool .
int	getContourFieldPrecision() Returns the Contour Field Precision parameter of this tool .
double	getIndexInterval() Returns the Index Interval parameter of this tool .
String	getIndexIntervalField() Returns the Index Interval Field parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
double	getInterval() Returns the Contour Interval parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution 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	setBaseContour(double baseContour) Sets the Base Contour parameter of this tool .
void	setContourField(String contourField) Sets the Contour Field parameter of this tool .
void	setContourFieldPrecision(int contourFieldPrecision) Sets the Contour Field Precision parameter of this tool .
void	setIndexInterval(double indexInterval) Sets the Index Interval parameter of this tool .
void	setIndexIntervalField(String indexIntervalField) Sets the Index Interval Field parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setInterval(double interval) Sets the Contour Interval parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution 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

SurfaceContour

public SurfaceContour()

Creates the Surface Contour tool with defaults.

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

SurfaceContour

public SurfaceContour(Object inSurface,
                      Object outFeatureClass,
                      double interval)

Creates the Surface Contour 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.

outFeatureClass - the output feature class.

interval - the interval between the contours.

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.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getInterval

public double getInterval()

Returns the Contour Interval parameter of this tool . This parameter is the interval between the contours. This is a required parameter.

Returns:

the Contour Interval

setInterval

public void setInterval(double interval)

Sets the Contour Interval parameter of this tool . This parameter is the interval between the contours. This is a required parameter.

Parameters:

interval - the interval between the contours.

getBaseContour

public double getBaseContour()

Returns the Base Contour parameter of this tool . This parameter is along with the index interval, the base height is used to determine what contours are produced. The base height is a starting point from which the index interval is either added or subtracted. By default, the base contour is 0.0. This is an optional parameter.

Returns:

the Base Contour

setBaseContour

public void setBaseContour(double baseContour)

Sets the Base Contour parameter of this tool . This parameter is along with the index interval, the base height is used to determine what contours are produced. The base height is a starting point from which the index interval is either added or subtracted. By default, the base contour is 0.0. This is an optional parameter.

Parameters:

baseContour - along with the index interval, the base height is used to determine what contours are produced. The base height is a starting point from which the index interval is either added or subtracted. By default, the base contour is 0.0.

getContourField

public String getContourField()

Returns the Contour Field parameter of this tool . This parameter is the field containing contour values. This is an optional parameter.

Returns:

the Contour Field

setContourField

public void setContourField(String contourField)

Sets the Contour Field parameter of this tool . This parameter is the field containing contour values. This is an optional parameter.

Parameters:

contourField - the field containing contour values.

getContourFieldPrecision

public int getContourFieldPrecision()

Returns the Contour Field Precision parameter of this tool . This parameter is the precision of the contour field. Zero specifies an integer, and the numbers 1–9 indicate how many decimal places the field will contain. By default, the field will be an integer (0). This is an optional parameter.

Returns:

the Contour Field Precision

setContourFieldPrecision

public void setContourFieldPrecision(int contourFieldPrecision)

Sets the Contour Field Precision parameter of this tool . This parameter is the precision of the contour field. Zero specifies an integer, and the numbers 1–9 indicate how many decimal places the field will contain. By default, the field will be an integer (0). This is an optional parameter.

Parameters:

contourFieldPrecision - the precision of the contour field. Zero specifies an integer, and the numbers 1–9 indicate how many decimal places the field will contain. By default, the field will be an integer (0).

getIndexInterval

public double getIndexInterval()

Returns the Index Interval parameter of this tool . This parameter is the difference, in Z units, between index contours. The value specified should be evenly divisible by the contour interval. Typically, it’s five times greater. Use of this parameter adds an attribute field to the output feature class that’s used to differentiate index contours from regular contours. This is an optional parameter.

Returns:

the Index Interval

setIndexInterval

public void setIndexInterval(double indexInterval)

Sets the Index Interval parameter of this tool . This parameter is the difference, in Z units, between index contours. The value specified should be evenly divisible by the contour interval. Typically, it’s five times greater. Use of this parameter adds an attribute field to the output feature class that’s used to differentiate index contours from regular contours. This is an optional parameter.

Parameters:

indexInterval - the difference, in Z units, between index contours. The value specified should be evenly divisible by the contour interval. Typically, it’s five times greater. Use of this parameter adds an attribute field to the output feature class that’s used to differentiate index contours from regular contours.

getIndexIntervalField

public String getIndexIntervalField()

Returns the Index Interval Field parameter of this tool . This parameter is the name of the field used to record whether a contour is a regular or an index contour. By default, the value is ‘Index’. This is an optional parameter.

Returns:

the Index Interval Field

setIndexIntervalField

public void setIndexIntervalField(String indexIntervalField)

Sets the Index Interval Field parameter of this tool . This parameter is the name of the field used to record whether a contour is a regular or an index contour. By default, the value is ‘Index’. This is an optional parameter.

Parameters:

indexIntervalField - the name of the field used to record whether a contour is a regular or an index contour. By default, the value is ‘Index’.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is specifies a factor by which to multiply the surface heights. Used to convert z units to x and y units. 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 specifies a factor by which to multiply the surface heights. Used to convert z units to x and y units. This is an optional parameter.

Parameters:

zFactor - specifies a factor by which to multiply the surface heights. Used to convert z units to x and y units.

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.

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