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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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 Allows 3D Z values in a Z enabled feature class to be changed. tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Adjust3DZ()
          Creates the Allows 3D Z values in a Z enabled feature class to be changed.
Adjust3DZ(Object inFeatures)
          Creates the Allows 3D Z values in a Z enabled feature class to be changed.
 
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 Allows 3D Z values in a Z enabled feature class to be changed. 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 Allows 3D Z values in a Z enabled feature class to be changed. 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 - Feature Layer, 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 Feature Layer, 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 Feature Layer, the input feature class containing Z-values in the SHAPE field. This is a required parameter.

Parameters:
inFeatures - Feature Layer, 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 String keyword, 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 String keyword, flips the sign of all the Z values in the feature class. This is an optional parameter.

Parameters:
reverseSign - String keyword, 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 Double, this parameters allows you to specify a value for a bulk shift. 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 Double, this parameters allows you to specify a value for a bulk shift. 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 - Double, this parameters allows you to specify a value for a bulk shift. 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 String keyword, this parameter is used in conjunction with Convert To Units. 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 String keyword, this parameter is used in conjunction with Convert To Units. This is an optional parameter.

Parameters:
fromUnits - String keyword, this parameter is used in conjunction with Convert To Units.

getToUnits

public String getToUnits()
Returns the Convert To Units parameter of this tool . This parameter is String keyword, this parameter is used in conjunction with Convert From Units. 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 String keyword, this parameter is used in conjunction with Convert From Units. This is an optional parameter.

Parameters:
toUnits - String keyword, this parameter is used in conjunction with Convert From Units.

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