com.esri.arcgis.geodatabaseextensions
Class TerrainBlobReader

java.lang.Object
  extended by com.esri.arcgis.geodatabaseextensions.TerrainBlobReader
All Implemented Interfaces:
ITerrainBlobReader, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TerrainBlobReader
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITerrainBlobReader

ESRI Terrain blob reader.

Description

TerrainBlobReader is an object used to access terrain/LIDAR related attributes packed into binary large objects (BLOBs). These BLOBs are created by the TerrainLasDataImporter, TerrainAsciiDataImporter, or the TerrainBlobWriter 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.

See Also:
Serialized Form

Constructor Summary
TerrainBlobReader()
          Constructs a TerrainBlobReader using ArcGIS Engine.
TerrainBlobReader(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainBlobReader theTerrainBlobReader = (TerrainBlobReader) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TerrainBlobReader

public TerrainBlobReader()
                  throws IOException,
                         UnknownHostException
Constructs a TerrainBlobReader using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TerrainBlobReader

public TerrainBlobReader(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainBlobReader theTerrainBlobReader = (TerrainBlobReader) obj;

Construct a TerrainBlobReader using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TerrainBlobReader.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setEmpty

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

Specified by:
setEmpty in interface ITerrainBlobReader
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKnownBlob

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

Specified by:
isKnownBlob in interface ITerrainBlobReader
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

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

Specified by:
setBlob in interface ITerrainBlobReader
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

public int getDataType()
                throws IOException,
                       AutomationException
Returns the data type of the blob.

Product Availability

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

Specified by:
getDataType in interface ITerrainBlobReader
Returns:
A com.esri.arcgis.geodatabaseextensions.esriTerrainBlobDataType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemCount

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

Specified by:
getItemCount in interface ITerrainBlobReader
Returns:
The pcItems
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

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

Specified by:
getValue in interface ITerrainBlobReader
Parameters:
index - The index (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.