com.esri.arcgis.geodatabase
Interface IRasterValue

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRasterValue2

All Known Implementing Classes:

RasterValue

public interface IRasterValue
extends Serializable

Provides access to members that control raster value.

Superseded By

IRasterValue2

Remarks

The IRasterValue interface provides access to the properties of a RasterValue, it allows you to hook a raster dataset to a RasterValue and store it using the parameters that the RasterStorageDef specifies.

The RasterDataset property provides the access to the raster dataset that is stored in the RasterValue. This is the entry point to load or update raster data in the geodatabase.

The Raster property provides the access to the raster that is stored in the RasterValue. This is another entry point to load or update raster data in the geodatabase.

The RasterDatasetName property provides another way to access the raster data stored in a RasterValue.

The RasterStorageDef property specifies the storage parameters for storing the raster data.

The SetEmptyRasterDataset method creates an empty raster dataset of specified number of bands and data type, so more data can be mosaiced to it later on. The nBands argument specifies the number of bands and the PixelType argument specified the pixeltype of the raster dataset.

Product Availability

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

See Also:

IRasterCatalogItem, RasterCatalog, RasterStorageDef

Method Summary

IEnvelope	getExtent() The extent of the raster value.
IRaster	getRaster() The raster of the raster value.
IRasterDataset	getRasterDataset() The raster dataset of the raster value.
IName	getRasterDatasetName() The raster dataset name of the raster value.
IRasterStorageDef	getRasterStorageDef() The raster storage properties.
void	setEmptyRasterDataset(int nBands, int pixelType) Sets up the empty raster dataset.
void	setExtentByRef(IEnvelope extent) The extent of the raster value.
void	setRasterByRef(IRaster raster) The raster of the raster value.
void	setRasterDatasetByRef(IRasterDataset dataset) The raster dataset of the raster value.
void	setRasterDatasetNameByRef(IName datasetName) The raster dataset name of the raster value.
void	setRasterStorageDefByRef(IRasterStorageDef storageDef) The raster storage properties.

Method Detail

getRasterStorageDef

IRasterStorageDef getRasterStorageDef()
                                      throws IOException,
                                             AutomationException

The raster storage properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterStorageDefByRef

void setRasterStorageDefByRef(IRasterStorageDef storageDef)
                              throws IOException,
                                     AutomationException

The raster storage properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setExtentByRef

void setExtentByRef(IEnvelope extent)
                    throws IOException,
                           AutomationException

The extent of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterDataset

IRasterDataset getRasterDataset()
                                throws IOException,
                                       AutomationException

The raster dataset of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterDatasetByRef

void setRasterDatasetByRef(IRasterDataset dataset)
                           throws IOException,
                                  AutomationException

The raster dataset of the raster value.

Remarks

Assigns a RasterDataset to the RasterValue, if the raster has a different spatial reference from the raster column of the raster catalog, the raster spatial reference is ignored and the raster column spatial reference is applied to the raster, but no projection or transformation is performed. To set the raster dataset spatial reference correctly, you need to get the raster datasets and alter its xform.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

dataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterDatasetName

IName getRasterDatasetName()
                           throws IOException,
                                  AutomationException

The raster dataset name of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterDatasetNameByRef

void setRasterDatasetNameByRef(IName datasetName)
                               throws IOException,
                                      AutomationException

The raster dataset name of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

datasetName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws IOException,
                         AutomationException

The raster of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(IRaster raster)
                    throws IOException,
                           AutomationException

The raster of the raster value.

Remarks

Assigns a Raster to the RasterValue, if the raster has a different spatial reference from the raster column of the raster catalog, the raster spatial reference is ignored and the raster column spatial reference is applied to the raster, but no projection or transformation is performed. To set the raster spatial reference correctly, you need to get the raster and alter its xform.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmptyRasterDataset

void setEmptyRasterDataset(int nBands,
                           int pixelType)
                           throws IOException,
                                  AutomationException

Sets up the empty raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

nBands - The nBands (in)

pixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.