com.esri.arcgis.geodatabaseextensions
Interface ILasDatasetEdit

All Superinterfaces:

Serializable

All Known Implementing Classes:

LasDataset

public interface ILasDatasetEdit
extends Serializable

Provides access to members of LasDataset.

Product Availability

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

Method Summary

void	addFile(String fileName) Adds a file to the dataset.
void	addFolder(String folderName, String fileExtension, boolean bRecursive, IStringArray[] ppBadFiles) Adds all the files in the specified a folder, and potentially subfolders, to the dataset.
void	addSurfaceConstraint(IFeatureClass pFeatureClass, IField pHeightField, IField pTagField, int type) Adds surface constraint (e.g., breaklines) to the dataset.
void	calculateFileStatistics(ITrackCancel pTrackCancel, int index) Calculate statistics of the specified file.
void	calculateStatistics(ITrackCancel pTrackCancel, boolean bForce, ILongArray[] ppBadFiles) Calculate statistics of the entire dataset.
void	removeFile(int index) Removes the specified file from the dataset.
void	removeFileByName(String fileName) Removes the specified file from the dataset.
void	removeSurfaceConstraint(IFeatureClass pFeatureClass) Removes the specified surface constraint from the dataset.
void	removeSurfaceConstraintByID(IUID pGuid) Removes the specified surface constraint from the dataset.
void	save() Saves the changes.
void	setSpatialReference(ISpatialReference pSpatialReference) Sets spatial reference.
void	setUsesRelativePath(boolean rhs1) Indicates if the dataset is saved with relative path.

Method Detail

save

void save()
          throws IOException,
                 AutomationException

Saves the changes.

Description

Save will persist all edits to the current LasDataset. If you want to preserve the original LasDataset, use ILasDataset.SaveAs.

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.

setUsesRelativePath

void setUsesRelativePath(boolean rhs1)
                         throws IOException,
                                AutomationException

Indicates if the dataset is saved with relative path.

Description

If set to true, all the las files and surface constraints referenced by the las dataset will be stored using relative paths.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReference

void setSpatialReference(ISpatialReference pSpatialReference)
                         throws IOException,
                                AutomationException

Sets spatial reference.

Description

Assign a spatial reference to the las dataset.

Product Availability

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

Parameters:

pSpatialReference - 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.

addFile

void addFile(String fileName)
             throws IOException,
                    AutomationException

Adds a file to the dataset.

Description

The file name must be the full path of the LAS file location on disk.

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,
               IStringArray[] ppBadFiles)
               throws IOException,
                      AutomationException

Adds all the files in the specified a folder, and potentially subfolders, to the dataset.

Description

Use this method to add multiple LAS files at once.

folderName is the full path of the folder.

fileExtension is used to add files of a certain type. Use the extension ‘las’ to add LAS files. This is case-insensitive.

bRecursive, if set to True, would also include LAS files in sub folders.

ppBadFiles is a string array that is populated with the names of the las files that could not be added to the las dataset. That includes files that are corrupt or invalid.

Product Availability

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

Parameters:

folderName - The folderName (in)

fileExtension - The fileExtension (in)

bRecursive - The bRecursive (in)

ppBadFiles - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFile

void removeFile(int index)
                throws IOException,
                       AutomationException

Removes the specified file from the dataset.

Description

Removes the reference to the LAS file at the specified index. Valid Index values range from 0 .. ILasDataset.FileCount-1.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFileByName

void removeFileByName(String fileName)
                      throws IOException,
                             AutomationException

Removes the specified file from the dataset.

Description

The fileName string must be a full path or the relative path of the LAS file.

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.

addSurfaceConstraint

void addSurfaceConstraint(IFeatureClass pFeatureClass,
                          IField pHeightField,
                          IField pTagField,
                          int type)
                          throws IOException,
                                 AutomationException

Adds surface constraint (e.g., breaklines) to the dataset.

Description

This method allows the addition of feature classes as surface constraints. Breaklines and clip polygons can be added in the form of line and polygon feature classes.

pFeatureClass is the feature class to be added.

pHeightField is the field that indicates where the heights for the features come from. If the shape geometry is 3D, and that's what you want to use, pass the Shape field of the feature class. Otherwise, a numeric field can be used. If the heights for the features should be interpolated from the existing state of the surface, pass a NULL pointer ('Nothing' in VB) to indicate the features do not have Z values of their own.

pTagField is a numeric field used to assign tags to corresponding elements in the TIN. Tag values are signed long integers that are assigned to nodes, edges, or triangles. They have user defined meaning (e.g. node accuracy, land cover, etc.). If no tag values are to be used pass a NULL pointer ('Nothing' in VB).

Type indicates how the surface constraint is incorporated into the triangulation.

Product Availability

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

Parameters:

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

pHeightField - A reference to a com.esri.arcgis.geodatabase.IField (in)

pTagField - A reference to a com.esri.arcgis.geodatabase.IField (in)

type - A com.esri.arcgis.geodatabase.esriTinSurfaceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeSurfaceConstraint

void removeSurfaceConstraint(IFeatureClass pFeatureClass)
                             throws IOException,
                                    AutomationException

Removes the specified surface constraint from the dataset.

Description

Removes the surface constraint specified by the input feature class.

pFeatureClass is the input surface constraint to be removed. If the feature class is not available on disk anymore, consider using ILasDatasetEdit.RemoveSurfaceConstraintByID to remove the surface constraint from the las dataset.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeSurfaceConstraintByID

void removeSurfaceConstraintByID(IUID pGuid)
                                 throws IOException,
                                        AutomationException

Removes the specified surface constraint from the dataset.

Description

Removes the surface constraint specified by the input UID.

pGuid is the UID of the input surface constraint to be removed. This method is handy when the feature class is not available on disk anymore.

Product Availability

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

Parameters:

pGuid - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateStatistics

void calculateStatistics(ITrackCancel pTrackCancel,
                         boolean bForce,
                         ILongArray[] ppBadFiles)
                         throws IOException,
                                AutomationException

Calculate statistics of the entire dataset.

Description

Computes the statistics for the las dataset.

pTrackCancel is a reference to a Cancel Tracker object that can be used to monitor progress and/or cancel the process. This can be set to a NULL pointer ('Nothing' in VB) if desired.

bForce, if set to false, statistics are computed only for the las files that have outdated or no statistics. Setting it true forces a re-compute of the statistics for all the las files.
ppBadFiles is the list of files for which the statistics computation has failed.

Product Availability

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

Parameters:

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

bForce - The bForce (in)

ppBadFiles - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateFileStatistics

void calculateFileStatistics(ITrackCancel pTrackCancel,
                             int index)
                             throws IOException,
                                    AutomationException

Calculate statistics of the specified file.

Description

Computes the statistics for the las file referenced by the specified index.

pTrackCancel is a reference to a Cancel Tracker object that can be used to monitor progress and/or cancel the process. This can be set to a NULL pointer ('Nothing' in VB) if desired.

index is the input index of the LAS file for which statistics need to be computed.

Product Availability

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

Parameters:

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

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.