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

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

All Implemented Interfaces:

GPTool

public class FeatureClassZToASCII
extends AbstractGPTool

Exports 3D points, multipoints, polylines, or polygons to ASCII text files in XYZ or GENERATE format. The Feature Class Z to ASCII tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• This tool will also export polylines to a profile ASCII output format. The text file for the profile output format will contain distance for y and z for x. The profile format enables 3D data to be exported into more specialized graphing applications.

Field Summary

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

vals

Constructor Summary

FeatureClassZToASCII()
Creates the Feature Class Z to ASCII tool with defaults.

FeatureClassZToASCII(Object inFeatureClass, Object outputLocation, String outFile)
Creates the Feature Class Z to ASCII tool with the required parameters.

Method Summary

String	getDecimalFormat() Returns the Decimal Notation parameter of this tool .
String	getDecimalSeparator() Returns the Decimal separator parameter of this tool .
String	getDelimiter() Returns the Delimiter parameter of this tool .
Object	getDerivedOutput() Returns the Output parameter of this tool (Read only).
int	getDigitsAfterDecimal() Returns the Digits after Decimal parameter of this tool .
String	getFormat() Returns the Output File Format parameter of this tool .
Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
String	getOutFile() Returns the Output Text File parameter of this tool .
Object	getOutputLocation() Returns the Output Location 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.
void	setDecimalFormat(String decimalFormat) Sets the Decimal Notation parameter of this tool .
void	setDecimalSeparator(String decimalSeparator) Sets the Decimal separator parameter of this tool .
void	setDelimiter(String delimiter) Sets the Delimiter parameter of this tool .
void	setDigitsAfterDecimal(int digitsAfterDecimal) Sets the Digits after Decimal parameter of this tool .
void	setFormat(String format) Sets the Output File Format parameter of this tool .
void	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setOutFile(String outFile) Sets the Output Text File parameter of this tool .
void	setOutputLocation(Object outputLocation) Sets the Output Location 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

FeatureClassZToASCII

public FeatureClassZToASCII()

Creates the Feature Class Z to ASCII tool with defaults.

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

FeatureClassZToASCII

public FeatureClassZToASCII(Object inFeatureClass,
                            Object outputLocation,
                            String outFile)

Creates the Feature Class Z to ASCII 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 feature class to export.

outputLocation - the folder where the file(s) will be written.

outFile - the output file name. The file name is used as a template when exporting a feature class containing multiple lines or polygons to XYZ format.

Method Detail

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the feature class to export. 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 feature class to export. This is a required parameter.

Parameters:

inFeatureClass - the feature class to export.

getOutputLocation

public Object getOutputLocation()

Returns the Output Location parameter of this tool . This parameter is the folder where the file(s) will be written. This is a required parameter.

Returns:

the Output Location

setOutputLocation

public void setOutputLocation(Object outputLocation)

Sets the Output Location parameter of this tool . This parameter is the folder where the file(s) will be written. This is a required parameter.

Parameters:

outputLocation - the folder where the file(s) will be written.

getOutFile

public String getOutFile()

Returns the Output Text File parameter of this tool . This parameter is the output file name. The file name is used as a template when exporting a feature class containing multiple lines or polygons to XYZ format. This is a required parameter.

Returns:

the Output Text File

setOutFile

public void setOutFile(String outFile)

Sets the Output Text File parameter of this tool . This parameter is the output file name. The file name is used as a template when exporting a feature class containing multiple lines or polygons to XYZ format. This is a required parameter.

Parameters:

outFile - the output file name. The file name is used as a template when exporting a feature class containing multiple lines or polygons to XYZ format.

getFormat

public String getFormat()

Returns the Output File Format parameter of this tool . This parameter is aSCII text formats for 3D feature data. These include GENERATE, XYZ, and PROFILE. This is an optional parameter.

Returns:

the Output File Format

setFormat

public void setFormat(String format)

Sets the Output File Format parameter of this tool . This parameter is aSCII text formats for 3D feature data. These include GENERATE, XYZ, and PROFILE. This is an optional parameter.

Parameters:

format - aSCII text formats for 3D feature data. These include GENERATE, XYZ, and PROFILE.

getDelimiter

public String getDelimiter()

Returns the Delimiter parameter of this tool . This parameter is the text character used to separate numbers. This is an optional parameter.

Returns:

the Delimiter

setDelimiter

public void setDelimiter(String delimiter)

Sets the Delimiter parameter of this tool . This parameter is the text character used to separate numbers. This is an optional parameter.

Parameters:

delimiter - the text character used to separate numbers.

getDecimalFormat

public String getDecimalFormat()

Returns the Decimal Notation parameter of this tool . This parameter is the decimal format of the output floating point values. AUTOMATIC determines how many digits are needed to preserve available precision while removing unnecessary trailing zeros. FIXED will write a specific number of digits after the decimal. The default is 3. This can be changed via the digits_after_decimal parameter. This is an optional parameter.

Returns:

the Decimal Notation

setDecimalFormat

public void setDecimalFormat(String decimalFormat)

Sets the Decimal Notation parameter of this tool . This parameter is the decimal format of the output floating point values. AUTOMATIC determines how many digits are needed to preserve available precision while removing unnecessary trailing zeros. FIXED will write a specific number of digits after the decimal. The default is 3. This can be changed via the digits_after_decimal parameter. This is an optional parameter.

Parameters:

decimalFormat - the decimal format of the output floating point values. AUTOMATIC determines how many digits are needed to preserve available precision while removing unnecessary trailing zeros. FIXED will write a specific number of digits after the decimal. The default is 3. This can be changed via the digits_after_decimal parameter.

getDigitsAfterDecimal

public int getDigitsAfterDecimal()

Returns the Digits after Decimal parameter of this tool . This parameter is used when the decimal_format is set to FIXED, this determines how many digits after the decimal are written for the floating point values written to the output file(s). This is an optional parameter.

Returns:

the Digits after Decimal

setDigitsAfterDecimal

public void setDigitsAfterDecimal(int digitsAfterDecimal)

Sets the Digits after Decimal parameter of this tool . This parameter is used when the decimal_format is set to FIXED, this determines how many digits after the decimal are written for the floating point values written to the output file(s). This is an optional parameter.

Parameters:

digitsAfterDecimal - used when the decimal_format is set to FIXED, this determines how many digits after the decimal are written for the floating point values written to the output file(s).

getDecimalSeparator

public String getDecimalSeparator()

Returns the Decimal separator parameter of this tool . This parameter is the ASCII file separator. The default is DECIMAL_POINT. This is an optional parameter.

Returns:

the Decimal separator

setDecimalSeparator

public void setDecimalSeparator(String decimalSeparator)

Sets the Decimal separator parameter of this tool . This parameter is the ASCII file separator. The default is DECIMAL_POINT. This is an optional parameter.

Parameters:

decimalSeparator - the ASCII file separator. The default is DECIMAL_POINT.

getDerivedOutput

public Object getDerivedOutput()

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

Returns:

the Output

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