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

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

All Implemented Interfaces:

GPTool

public class Ascii3DToFeatureClass
extends AbstractGPTool

Imports 3D features from one or more ASCII files into a new output feature class. This tool imports XYZ or XYZI or GENERATE file formats. The ASCII 3D to Feature Class tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• When multiple files are input they should all be in the same format, either XYZ, XYZI, or GENERATE, and be of the same geometry type.

Field Summary

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

vals

Constructor Summary

Ascii3DToFeatureClass()
Creates the ASCII 3D to Feature Class tool with defaults.

Ascii3DToFeatureClass(Object input, String inFileType, Object outFeatureClass, String outGeometryType)
Creates the ASCII 3D to Feature Class tool with the required parameters.

Method Summary

double	getAveragePointSpacing() Returns the Average Point Spacing parameter of this tool .
String	getDecimalSeparator() Returns the Decimal separator parameter of this tool .
String	getFileSuffix() Returns the File Suffix parameter of this tool .
String	getInFileType() Returns the Input File Format parameter of this tool .
Object	getInput() Returns the Input parameter of this tool .
Object	getInputCoordinateSystem() Returns the Input Coordinate System parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getOutGeometryType() Returns the Output Feature Class Type 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	setAveragePointSpacing(double averagePointSpacing) Sets the Average Point Spacing parameter of this tool .
void	setDecimalSeparator(String decimalSeparator) Sets the Decimal separator parameter of this tool .
void	setFileSuffix(String fileSuffix) Sets the File Suffix parameter of this tool .
void	setInFileType(String inFileType) Sets the Input File Format parameter of this tool .
void	setInput(Object input) Sets the Input parameter of this tool .
void	setInputCoordinateSystem(Object inputCoordinateSystem) Sets the Input Coordinate System parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutGeometryType(String outGeometryType) Sets the Output Feature Class Type 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

Ascii3DToFeatureClass

public Ascii3DToFeatureClass()

Creates the ASCII 3D to Feature Class tool with defaults.

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

Ascii3DToFeatureClass

public Ascii3DToFeatureClass(Object input,
                             String inFileType,
                             Object outFeatureClass,
                             String outGeometryType)

Creates the ASCII 3D to Feature Class 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:

input - one or more input files or folders with data in ASCII XYZ or XYZI (with lidar intensity) or 3-D GENERATE format. If a folder is specified all the files inside the folder named with the same extension as the file suffix parameter will be used. If multiple files are involved they need to be in the same format.

inFileType - the format of the input file(s).

outFeatureClass - the output feature class.

outGeometryType - the geometry type of the output feature class. the output feature class type may be set to POINT | MULTIPOINT | POLYLINE | POLYGON. When points are input the only valid types are POINT or MULTIPOINT. Multipoints are recommended when you don’t intend to add any attribution on a per point basis and especially when many thousands or millions of points are involved. When the input represents polylines the output type must be set to POLYLINE. When the input represents polygons the output type may be set to POLYGON, or POLYLINE.

Method Detail

getInput

public Object getInput()

Returns the Input parameter of this tool . This parameter is one or more input files or folders with data in ASCII XYZ or XYZI (with lidar intensity) or 3-D GENERATE format. If a folder is specified all the files inside the folder named with the same extension as the file suffix parameter will be used. If multiple files are involved they need to be in the same format. This is a required parameter.

Returns:

the Input

setInput

public void setInput(Object input)

Sets the Input parameter of this tool . This parameter is one or more input files or folders with data in ASCII XYZ or XYZI (with lidar intensity) or 3-D GENERATE format. If a folder is specified all the files inside the folder named with the same extension as the file suffix parameter will be used. If multiple files are involved they need to be in the same format. This is a required parameter.

Parameters:

input - one or more input files or folders with data in ASCII XYZ or XYZI (with lidar intensity) or 3-D GENERATE format. If a folder is specified all the files inside the folder named with the same extension as the file suffix parameter will be used. If multiple files are involved they need to be in the same format.

getInFileType

public String getInFileType()

Returns the Input File Format parameter of this tool . This parameter is the format of the input file(s). This is a required parameter.

Returns:

the Input File Format

setInFileType

public void setInFileType(String inFileType)

Sets the Input File Format parameter of this tool . This parameter is the format of the input file(s). This is a required parameter.

Parameters:

inFileType - the format of the input file(s).

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getOutGeometryType

public String getOutGeometryType()

Returns the Output Feature Class Type parameter of this tool . This parameter is the geometry type of the output feature class. the output feature class type may be set to POINT | MULTIPOINT | POLYLINE | POLYGON. When points are input the only valid types are POINT or MULTIPOINT. Multipoints are recommended when you don’t intend to add any attribution on a per point basis and especially when many thousands or millions of points are involved. When the input represents polylines the output type must be set to POLYLINE. When the input represents polygons the output type may be set to POLYGON, or POLYLINE. This is a required parameter.

Returns:

the Output Feature Class Type

setOutGeometryType

public void setOutGeometryType(String outGeometryType)

Sets the Output Feature Class Type parameter of this tool . This parameter is the geometry type of the output feature class. the output feature class type may be set to POINT | MULTIPOINT | POLYLINE | POLYGON. When points are input the only valid types are POINT or MULTIPOINT. Multipoints are recommended when you don’t intend to add any attribution on a per point basis and especially when many thousands or millions of points are involved. When the input represents polylines the output type must be set to POLYLINE. When the input represents polygons the output type may be set to POLYGON, or POLYLINE. This is a required parameter.

Parameters:

outGeometryType - the geometry type of the output feature class. the output feature class type may be set to POINT | MULTIPOINT | POLYLINE | POLYGON. When points are input the only valid types are POINT or MULTIPOINT. Multipoints are recommended when you don’t intend to add any attribution on a per point basis and especially when many thousands or millions of points are involved. When the input represents polylines the output type must be set to POLYLINE. When the input represents polygons the output type may be set to POLYGON, or POLYLINE.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the Z Factor is a multiplier applied to the input z values to convert between units such as feet to meters and to convert between signs (e.g. positive depths into negative heights relative to sea level). Use a negative factor to reverse signs. The default is 1.0, or no change. 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 Z Factor is a multiplier applied to the input z values to convert between units such as feet to meters and to convert between signs (e.g. positive depths into negative heights relative to sea level). Use a negative factor to reverse signs. The default is 1.0, or no change. This is an optional parameter.

Parameters:

zFactor - the Z Factor is a multiplier applied to the input z values to convert between units such as feet to meters and to convert between signs (e.g. positive depths into negative heights relative to sea level). Use a negative factor to reverse signs. The default is 1.0, or no change.

getInputCoordinateSystem

public Object getInputCoordinateSystem()

Returns the Input Coordinate System parameter of this tool . This parameter is the coordinate system of the input data. This is an optional parameter.

Returns:

the Input Coordinate System

setInputCoordinateSystem

public void setInputCoordinateSystem(Object inputCoordinateSystem)

Sets the Input Coordinate System parameter of this tool . This parameter is the coordinate system of the input data. This is an optional parameter.

Parameters:

inputCoordinateSystem - the coordinate system of the input data.

getAveragePointSpacing

public double getAveragePointSpacing()

Returns the Average Point Spacing parameter of this tool . This parameter is the average planimetric distance between points of the input. This parameter is only used when the output geometry type is set to MULTIPOINT. Its used as a means to bin, or group, the points together. Specify the spacing in the horizontal units of the target feature class. This is an optional parameter.

Returns:

the Average Point Spacing

setAveragePointSpacing

public void setAveragePointSpacing(double averagePointSpacing)

Sets the Average Point Spacing parameter of this tool . This parameter is the average planimetric distance between points of the input. This parameter is only used when the output geometry type is set to MULTIPOINT. Its used as a means to bin, or group, the points together. Specify the spacing in the horizontal units of the target feature class. This is an optional parameter.

Parameters:

averagePointSpacing - the average planimetric distance between points of the input. This parameter is only used when the output geometry type is set to MULTIPOINT. Its used as a means to bin, or group, the points together. Specify the spacing in the horizontal units of the target feature class.

getFileSuffix

public String getFileSuffix()

Returns the File Suffix parameter of this tool . This parameter is the suffix of the files to import when a folder is specified on input. This is an optional parameter.

Returns:

the File Suffix

setFileSuffix

public void setFileSuffix(String fileSuffix)

Sets the File Suffix parameter of this tool . This parameter is the suffix of the files to import when a folder is specified on input. This is an optional parameter.

Parameters:

fileSuffix - the suffix of the files to import when a folder is specified on input.

getDecimalSeparator

public String getDecimalSeparator()

Returns the Decimal separator parameter of this tool . This parameter is the character used to represent a decimal for floating point numbers in the input file(s). 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 character used to represent a decimal for floating point numbers in the input file(s). The default is decimal point. This is an optional parameter.

Parameters:

decimalSeparator - the character used to represent a decimal for floating point numbers in the input file(s). The default is decimal point.

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