com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class Adjust3DZ

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.Adjust3DZ

All Implemented Interfaces:

GPTool

public class Adjust3DZ
extends AbstractGPTool

Allows the modification of all Z-values in a Z-enabled feature class. The Adjust 3D Z tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool modifies the input data. See for more information and strategies to avoid undesired data changes.
• Bathymetry data often has positive Z-values. You may wish to reverse the signs of all the data in the feature class to make the Z-values negative.
• Z-enabled data could be referenced to a vertical datum that is not appropriate for your geoprocessing needs. This tool could apply a bulk-shift of all the Z-values in the feature class to adjust the data either up or down vertically.
• The Convert From Units and Convert To Units parameters allow you to convert your Z-values from one common unit of measure to another.

Field Summary

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

vals

Constructor Summary

Adjust3DZ()
Creates the Adjust 3D Z tool with defaults.

Adjust3DZ(Object inFeatures)
Creates the Adjust 3D Z tool with the required parameters.

Method Summary

double	getAdjustValue() Returns the Adjust Z Value parameter of this tool .
String	getFromUnits() Returns the Convert From Units parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool (Read only).
String	getReverseSign() Returns the Reverse Sign of Z Values 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.
String	getToUnits() Returns the Convert To Units parameter of this tool .
void	setAdjustValue(double adjustValue) Sets the Adjust Z Value parameter of this tool .
void	setFromUnits(String fromUnits) Sets the Convert From Units parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setReverseSign(String reverseSign) Sets the Reverse Sign of Z Values parameter of this tool .
void	setToUnits(String toUnits) Sets the Convert To Units 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

Adjust3DZ

public Adjust3DZ()

Creates the Adjust 3D Z tool with defaults.

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

Adjust3DZ

public Adjust3DZ(Object inFeatures)

Creates the Adjust 3D Z 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:

inFeatures - the input feature class containing Z-values in the SHAPE field.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature class containing Z-values in the SHAPE field. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input feature class containing Z-values in the SHAPE field. This is a required parameter.

Parameters:

inFeatures - the input feature class containing Z-values in the SHAPE field.

getReverseSign

public String getReverseSign()

Returns the Reverse Sign of Z Values parameter of this tool . This parameter is flips the sign of all the Z-values in the feature class. This is an optional parameter.

Returns:

the Reverse Sign of Z Values

setReverseSign

public void setReverseSign(String reverseSign)

Sets the Reverse Sign of Z Values parameter of this tool . This parameter is flips the sign of all the Z-values in the feature class. This is an optional parameter.

Parameters:

reverseSign - flips the sign of all the Z-values in the feature class.

getAdjustValue

public double getAdjustValue()

Returns the Adjust Z Value parameter of this tool . This parameter is a value to apply to all Z-values. To decrease the Z-values for the entire feature class, enter a negative number. To increase, enter a positive value. This is an optional parameter.

Returns:

the Adjust Z Value

setAdjustValue

public void setAdjustValue(double adjustValue)

Sets the Adjust Z Value parameter of this tool . This parameter is a value to apply to all Z-values. To decrease the Z-values for the entire feature class, enter a negative number. To increase, enter a positive value. This is an optional parameter.

Parameters:

adjustValue - a value to apply to all Z-values. To decrease the Z-values for the entire feature class, enter a negative number. To increase, enter a positive value.

getFromUnits

public String getFromUnits()

Returns the Convert From Units parameter of this tool . This parameter is the existing units of the Z-values. This parameter is used in conjunction with the Convert To Units parameter. This is an optional parameter.

Returns:

the Convert From Units

setFromUnits

public void setFromUnits(String fromUnits)

Sets the Convert From Units parameter of this tool . This parameter is the existing units of the Z-values. This parameter is used in conjunction with the Convert To Units parameter. This is an optional parameter.

Parameters:

fromUnits - the existing units of the Z-values. This parameter is used in conjunction with the Convert To Units parameter.

getToUnits

public String getToUnits()

Returns the Convert To Units parameter of this tool . This parameter is the units to convert to. This is an optional parameter.

Returns:

the Convert To Units

setToUnits

public void setToUnits(String toUnits)

Sets the Convert To Units parameter of this tool . This parameter is the units to convert to. This is an optional parameter.

Parameters:

toUnits - the units to convert to.

getOutFeatureClass

public Object getOutFeatureClass()

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