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

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

All Implemented Interfaces:

GPTool

public class AddZInformation
extends AbstractGPTool

Examines each 3D shape and adds selected properties as attributes to the input feature class. The output options vary based on the input shape type. The Add Z Information tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The z output property options, by shape type, are:
• Slope can be calculated in different ways depending on the output features. Slope for a line is calculated by examining each of its segments. The min and max slope values are taken from the segment that is either closest to horizontal or most extreme. The average slope is determined by averaging the slope for all segments weighted by their 3D length. Longer segments will have more influence than shorter segments.
• When using the volume option on multipatches the resulting volume will be set to 0.0 for those multipatches that are not closed. On the Solaris platform, it is a design limit that the tool is unable to determine whether or not multipatches are closed. Therefore, volume will be calculated for all multipatches under the assumption they are closed.

Field Summary

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

vals

Constructor Summary

AddZInformation()
Creates the Add Z Information tool with defaults.

AddZInformation(Object inFeatureClass, Object outProperty)
Creates the Add Z Information tool with the required parameters.

Method Summary

Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
String	getNoiseFiltering() Returns the Noise Filtering 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).
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	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setNoiseFiltering(String noiseFiltering) Sets the Noise Filtering parameter of this tool .
void	setOutProperty(Object outProperty) Sets the Output Property 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

AddZInformation

public AddZInformation()

Creates the Add Z Information tool with defaults.

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

AddZInformation

public AddZInformation(Object inFeatureClass,
                       Object outProperty)

Creates the Add Z 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 feature class that Z information will be added to the attribute table.

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 feature class that Z information will be added to the attribute table. 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 feature class that Z information will be added to the attribute table. This is a required parameter.

Parameters:

inFeatureClass - the input feature class that Z information will be added to the attribute table.

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.

getNoiseFiltering

public String getNoiseFiltering()

Returns the Noise Filtering parameter of this tool . This parameter is allows you to exclude small portions of features from statistical calculations. This option is useful for obtaining good maximum slope estimates. Small portions of features often exhibit extreme slopes, which may bias the statistical results. the values given in either the Area or Length options will be used to exclude these portions of features. Points and Multipoints do not apply. This is an optional parameter.

Returns:

the Noise Filtering

setNoiseFiltering

public void setNoiseFiltering(String noiseFiltering)

Sets the Noise Filtering parameter of this tool . This parameter is allows you to exclude small portions of features from statistical calculations. This option is useful for obtaining good maximum slope estimates. Small portions of features often exhibit extreme slopes, which may bias the statistical results. the values given in either the Area or Length options will be used to exclude these portions of features. Points and Multipoints do not apply. This is an optional parameter.

Parameters:

noiseFiltering - allows you to exclude small portions of features from statistical calculations. This option is useful for obtaining good maximum slope estimates. Small portions of features often exhibit extreme slopes, which may bias the statistical results. the values given in either the Area or Length options will be used to exclude these portions of features. Points and Multipoints do not apply.

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