com.esri.arcgis.geodatabaseextensions
Interface ITerrainBlobWriter

All Superinterfaces:

Serializable

All Known Implementing Classes:

TerrainBlobWriter

public interface ITerrainBlobWriter
extends Serializable

Provides access to members that construct an attribute blob.

Description

ITerrainBlobWriter provides methods for creating BLOBs that can be interpreted/read by the TerrainBlobReader.

Product Availability

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

Method Summary

void	addValue(Object value) Adds an attribute value to the blob.
void	beginAddingValue(int type) Initialize a new blob with the specified data type.
IMemoryBlobStream	endAddingValue() Completes writing the blob and returns a reference to the blob object.
int	getItemCount() Returns the number of attribute values contained in the blob.

Method Detail

beginAddingValue

void beginAddingValue(int type)
                      throws IOException,
                             AutomationException

Initialize a new blob with the specified data type.

Description

BeginAddingValue is used to initialize a new BLOB to one of the supported numeric types (see esriTerrainBlobDataType). All values in an individual TerrainBlob are the same type; homogeneous.

After calling BeginAddingValue you use ITerrainBlobWriter.AddValue to populate the BLOB.

Product Availability

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

Parameters:

type - A com.esri.arcgis.geodatabaseextensions.esriTerrainBlobDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addValue

void addValue(Object value)
              throws IOException,
                     AutomationException

Adds an attribute value to the blob.

Description

Ideally, the variable type used for assignment should match the BLOB type (see ITerrainBlobWriter.BeginAddingValue) to ensure the value is properly maintained. Since this is not always possible (e.g., VB does not support 'char'), for flexibility the value is cast so you are not forced to use the same types. If the types don't match the value may get mangled if it's outide the BLOB type's range.

Product Availability

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

Parameters:

value - A Variant (in)

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.

endAddingValue

IMemoryBlobStream endAddingValue()
                                 throws IOException,
                                        AutomationException

Completes writing the blob and returns a reference to the blob object.

Description

EndAddingValue indicates there are no more values to be added. This completes and returns a TerrainBlob object. It can be interpreted by the TerrainBlobReader.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IMemoryBlobStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.