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

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

All Implemented Interfaces:

GPTool

public class AddSurfaceInformation
extends AbstractGPTool

Add Surface Information uses a surface to interpolate heights for features, converting them to 3D in the background, calculates 3D properties for these features, then writes the property values as attributes to the input feature class. The output z information options vary depending on shape type of the input feature class. The Add Surface Information tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The z output property options, by shape type, are:

Field Summary

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

vals

Constructor Summary

AddSurfaceInformation()
Creates the Add Surface Information tool with defaults.

AddSurfaceInformation(Object inFeatureClass, Object inSurface, Object outProperty)
Creates the Add Surface Information tool with the required parameters.

Method Summary

Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
String	getMethod() Returns the Method parameter of this tool .
Object	getOutProperty() Returns the Output Property parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool (Read only).
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
double	getSampleDistance() Returns the Sampling Distance 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	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setMethod(String method) Sets the Method parameter of this tool .
void	setOutProperty(Object outProperty) Sets the Output Property parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setSampleDistance(double sampleDistance) Sets the Sampling Distance 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

AddSurfaceInformation

public AddSurfaceInformation()

Creates the Add Surface Information tool with defaults.

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

AddSurfaceInformation

public AddSurfaceInformation(Object inFeatureClass,
                             Object inSurface,
                             Object outProperty)

Creates the Add Surface Information 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:

inFeatureClass - the input 2D feature class.

inSurface - the input raster, triangulated irregular network (TIN), or terrain dataset surface to be used as a source of z-values.

outProperty - the output z properties that will be added to the attribute table of the input feature class.

Method Detail

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input 2D feature class. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the input 2D feature class. This is a required parameter.

Parameters:

inFeatureClass - the input 2D feature class.

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the input raster, triangulated irregular network (TIN), or terrain dataset surface to be used as a source of z-values. 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 raster, triangulated irregular network (TIN), or terrain dataset surface to be used as a source of z-values. This is a required parameter.

Parameters:

inSurface - the input raster, triangulated irregular network (TIN), or terrain dataset surface to be used as a source of z-values.

getOutProperty

public Object getOutProperty()

Returns the Output Property parameter of this tool . This parameter is the output z properties that will be added to the attribute table of the input feature class. This is a required parameter.

Returns:

the Output Property

setOutProperty

public void setOutProperty(Object outProperty)

Sets the Output Property parameter of this tool . This parameter is the output z properties that will be added to the attribute table of the input feature class. This is a required parameter.

Parameters:

outProperty - the output z properties that will be added to the attribute table of the input feature class.

getMethod

public String getMethod()

Returns the Method parameter of this tool . This parameter is interpolation method used to define the Z values for the input features. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(String method)

Sets the Method parameter of this tool . This parameter is interpolation method used to define the Z values for the input features. This is an optional parameter.

Parameters:

method - interpolation method used to define the Z values for the input features.

getSampleDistance

public double getSampleDistance()

Returns the Sampling Distance parameter of this tool . This parameter is the spacing at which z-values will be interpolated. By default, this is a raster's cell size or a terrain or TIN's natural densification. This is an optional parameter.

Returns:

the Sampling Distance

setSampleDistance

public void setSampleDistance(double sampleDistance)

Sets the Sampling Distance parameter of this tool . This parameter is the spacing at which z-values will be interpolated. By default, this is a raster's cell size or a terrain or TIN's natural densification. This is an optional parameter.

Parameters:

sampleDistance - the spacing at which z-values will be interpolated. By default, this is a raster's cell size or a terrain or TIN's natural densification.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor by which the heights of the input surface will be multiplied to calculate new heights in the output feature class. It is used for converting z-units to match x,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 the factor by which the heights of the input surface will be multiplied to calculate new heights in the output feature class. It is used for converting z-units to match x,y units. This is an optional parameter.

Parameters:

zFactor - the factor by which the heights of the input surface will be multiplied to calculate new heights in the output feature class. It is used for converting z-units to match x,y units.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for geoprocessing. 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 resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Feature Class

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