com.esri.arcgis.geodatabaseextensions
Interface ITerrainBlobReader

All Superinterfaces:

Serializable

All Known Implementing Classes:

TerrainBlobReader

public interface ITerrainBlobReader
extends Serializable

Provides access to members that provide information about an attribute blob.

Description

ITerrainBlobReader provides methods to access terrain related attributes (e.g., lidar intensity) packed into binary large objects (BLOBs). The BLOBs are used as a means of storing per vertex attribution for points clustered into multipoint shapes.

Product Availability

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

Method Summary

int	getDataType() Returns the data type of the blob.
int	getItemCount() Returns the number of attribute values contained in the blob.
Object	getValue(int index) Returns the value of the attribute specified by the index.
boolean	isKnownBlob(IMemoryBlobStream pBlob) Indicates if Terrain can recognize the blob.
void	setBlob(IMemoryBlobStream pBlob) Assigns a blob to the reader.
void	setEmpty() Uninitialize the object.

Method Detail

setEmpty

void setEmpty()
              throws IOException,
                     AutomationException

Uninitialize the object.

Description

SetEmpty allows developers to release resources (e.g., memory and other objects) held by the reader at any time, rather than having to wait until the reader goes out of its scope.

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.

isKnownBlob

boolean isKnownBlob(IMemoryBlobStream pBlob)
                    throws IOException,
                           AutomationException

Indicates if Terrain can recognize the blob.

Description

IsKnownBlob returns TRUE if the BLOB is recognized as a supported type as created by the TerrainLasDataImporter or the TerrainBlobWriter.

Product Availability

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

Parameters:

pBlob - A reference to a com.esri.arcgis.system.IMemoryBlobStream (in)

Returns:

The pbIsKnown

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBlob

void setBlob(IMemoryBlobStream pBlob)
             throws IOException,
                    AutomationException

Assigns a blob to the reader.

Description

SetBlob is used to assign a reference for a compatible BLOB to the TerrainBlobReader for interpretation.

Notes

- The BLOB referenced must be a compatible type. These include BLOBs made by the TerrainBlobWriter and the TerrainLasDataImporter.
- If you're unsure of compatibility you can test it using ITerrainBlobReader.IsKnownBlob.

Product Availability

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

Parameters:

pBlob - A reference to a com.esri.arcgis.system.IMemoryBlobStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

int getDataType()
                throws IOException,
                       AutomationException

Returns the data type of the blob.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabaseextensions.esriTerrainBlobDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemCount

int getItemCount()
                 throws IOException,
                        AutomationException

Returns the number of attribute values contained in the blob.

Product Availability

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

Returns:

The pcItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue(int index)
                throws IOException,
                       AutomationException

Returns the value of the attribute specified by the index.

Description

GetValue returns the nth value in the BLOB. The index value that's passed, in the context of reading attributes for terrain points, is the point ID which should be stored for each vertex of the multipoint which is paired with the BLOB being read.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.