com.esri.arcgis.geodatabaseextensions
Interface ITerrainDataImporter

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITerrainAsciiDataImporter, ITerrainAsciiDataImporter2, ITerrainLasDataImporter

All Known Implementing Classes:

TerrainAsciiDataImporter, TerrainLasDataImporter

public interface ITerrainDataImporter
extends Serializable

Provides access to members that handle importing terrain source data.

Description

The ITerrainDataImporter interface is inherited by ITerrainAsciiDataImporter and ITerrainLasDataImporter. Its members are used to set properties related to loading points from one or more files into a target multipoint feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	addFile(String fileName) Include a specific file to be loaded upon Import.
void	addFolder(String folderName, String fileExtension, boolean bRecursive) Include a folder, and potentially subfolders, to be loaded upon import.
void	esri_import(IFeatureClass pOutputFeatureClass, double tileSize, double zFactor, IEnvelope pAOI, ITrackCancel pTrackCancel, int[] pcOutsidePoints) Loads the specified data, based on the current properties, into the target feature class.
IEnvelope	getDataExtent(ISpatialReference pTargetSpatialReference) The XYZ extent of data contained in files/folders to be added.
int	getMaxShapePointCount() The maximum number of points loaded into individual multipoint shapes.
double	getPointCount() The number of points in the files/folders to be added.
void	overwriteMaxShapePointCount(int newCount) Changes the default maximum number of points loaded into individual multipoint shapes.
void	setEmpty() Clears all properties.
void	setSourceDataSpatialReference(ISpatialReference pSpatialRef) Set source data's spatial reference.

Method Detail

setSourceDataSpatialReference

void setSourceDataSpatialReference(ISpatialReference pSpatialRef)
                                   throws IOException,
                                          AutomationException

Set source data's spatial reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pSpatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmpty

void setEmpty()
              throws IOException,
                     AutomationException

Clears all properties.

Description

SetEmpty clears all the properties but keeps the object alive. Use this when needing to clear the file or folder lists of the importer while in a loop. Keep in the mind the other properties will also need to be reset. Nevertheless, this is less expensive than instantiating the object repeatedly.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxShapePointCount

int getMaxShapePointCount()
                          throws IOException,
                                 AutomationException

The maximum number of points loaded into individual multipoint shapes.

Description

The importer writes out multipoint records. The MaxShapePointCount represents the largest number of points an individual multipoint record can contain. The default is 5000. Use OverwriteMaxShapePointCount to change this value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

overwriteMaxShapePointCount

void overwriteMaxShapePointCount(int newCount)
                                 throws IOException,
                                        AutomationException

Changes the default maximum number of points loaded into individual multipoint shapes.

Description

This will reset the MaxShapePointCount in case you don't want to use the default of 5000.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

newCount - The newCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFile

void addFile(String fileName)
             throws IOException,
                    AutomationException

Include a specific file to be loaded upon Import.

Description

The importer supports the input of one or more files at a time. Call AddFile, and repeat as necessary, to handle individual files. Provide the full path. Call SetEmpty to clear this list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFolder

void addFolder(String folderName,
               String fileExtension,
               boolean bRecursive)
               throws IOException,
                      AutomationException

Include a folder, and potentially subfolders, to be loaded upon import.

Description

The importer supports the input of one or more folders worth of files at a time. You can call AddFolder repeatedly. Call SetEmpty to clear this list.

fileExtension is the suffix of the file(s), excluding the dot ('.'). Only files with this suffix in the selected folder(s) will be read.

bRecursive is a boolean to indicate whether or not to recurse below the specified folders into their subfolders to look for more files.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

folderName - The folderName (in)

fileExtension - The fileExtension (in)

bRecursive - The bRecursive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataExtent

IEnvelope getDataExtent(ISpatialReference pTargetSpatialReference)
                        throws IOException,
                               AutomationException

The XYZ extent of data contained in files/folders to be added.

Description

Returns the data extent of points in the files referenced by the importer. See AddFile and AddFolder.

LAS format LIDAR files contain the data extent in the header. From them, the extent can be extracted quickly. ASCII files, on the other hand, must be scanned to discover the extent. The time this will take is proportional to the amount of data to scan through.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pTargetSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointCount

double getPointCount()
                     throws IOException,
                            AutomationException

The number of points in the files/folders to be added.

Description

Returns the number of points in the files referenced by the importer. See AddFile and AddFolder.

For LAS data the desired return numbers and/or class codes, as set by ITerrainLasDataImporter, will be taken into consideration. You must include some returns via ITerrainLasDataImporter.AddReturnNumber. The LAS specification records the number of points by return in the header so getting counts by return will be fast. On the other hand, if class codes are specified (see ITerrainLasDataImporter.AddClassCodes) the files must be scanned to determine the count. The time this will take is proportional to the amount of data to scan through.

Introduced in LAS version 1.1 is a Witheld flag as a point property. GetPointCount does not take this flag into consideration when totaling points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_import

void esri_import(IFeatureClass pOutputFeatureClass,
                 double tileSize,
                 double zFactor,
                 IEnvelope pAOI,
                 ITrackCancel pTrackCancel,
                 int[] pcOutsidePoints)
                 throws IOException,
                        AutomationException

Loads the specified data, based on the current properties, into the target feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pOutputFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

tileSize - The tileSize (in)

zFactor - The zFactor (in)

pAOI - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

pcOutsidePoints - The pcOutsidePoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.