com.esri.arcgis.datasourcesraster
Interface IRasterCollection

All Superinterfaces:

Serializable

All Known Implementing Classes:

MosaicRaster

public interface IRasterCollection
extends Serializable

Provides access to members that control a raster collection.

Remarks

The Remove and Empty method will remove the rasters from the MoaicRaster, it does not release the raster object from application. For .NET developers, to prevent the application from holding input rasters or the ouput raster, you must make explicitly call to release the references to the rasters or raster datasets being used:

System.Runtime.InteropServices.Marshal.ReleaseComObject(inputRasterDS);

Product Availability

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

See Also:

MosaicRaster

Method Summary

void	append(IRaster pRaster) Appends a raster to the end.
void	empty() Empties this raster collection.
int	find(IRaster pRaster) Finds a given raster and returns its index position.
IRaster	get(int index) Gets the raster at a given index position.
int	getRasterCount() The number of rasters in this raster collection.
void	insert(int index, IRaster pRaster) Inserts a raster at a given index.
void	populate(IEnvelope pExtent) Populates this raster collection from associated RasterCatalog.
void	remove(int index) Removes a raster at a given index.
void	set(int index, IRaster pRaster) Sets the raster at a given index position.

Method Detail

getRasterCount

int getRasterCount()
                   throws IOException,
                          AutomationException

The number of rasters in this raster collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IRaster pRaster)
            throws IOException,
                   AutomationException

Inserts a raster at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

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

append

void append(IRaster pRaster)
            throws IOException,
                   AutomationException

Appends a raster to the end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes a raster at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

int find(IRaster pRaster)
         throws IOException,
                AutomationException

Finds a given raster and returns its index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

get

IRaster get(int index)
            throws IOException,
                   AutomationException

Gets the raster at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

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.

set

void set(int index,
         IRaster pRaster)
         throws IOException,
                AutomationException

Sets the raster at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

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

empty

void empty()
           throws IOException,
                  AutomationException

Empties this raster collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

populate

void populate(IEnvelope pExtent)
              throws IOException,
                     AutomationException

Populates this raster collection from associated RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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