com.esri.arcgis.datasourcesraster
Interface IRasterDatasetJukebox

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterDataset

public interface IRasterDatasetJukebox
extends Serializable

Provides access to members that control subdatasets.

Remarks

Some raster formats can contain multiple subdatasets inside a single file, for example the HDF format. The IRasterDatasetJukebox interface is used to query the number of subdatasets, their names, and the descriptions inside the file and retrive subdatasets, one at a time.

Product Availability

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

Method Summary

int	getSubdataset() The current active subdataset.
int	getSubdatasetCount() The number of subdatasets.
String	getSubdatasetDescription(int subdatasetID) The given subdataset description.
String	getSubdatasetName(int subdatasetID) The given subdataset name.
void	setSubdataset(int pSubdatasetID) The current active subdataset.

Method Detail

getSubdatasetCount

int getSubdatasetCount()
                       throws IOException,
                              AutomationException

The number of subdatasets.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubdataset

int getSubdataset()
                  throws IOException,
                         AutomationException

The current active subdataset.

Remarks

This property is used to get/set the index of a subdataset which becomes the current raster dataset

Product Availability

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

Returns:

The pSubdatasetID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubdataset

void setSubdataset(int pSubdatasetID)
                   throws IOException,
                          AutomationException

The current active subdataset.

Product Availability

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

Parameters:

pSubdatasetID - The pSubdatasetID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubdatasetName

String getSubdatasetName(int subdatasetID)
                         throws IOException,
                                AutomationException

The given subdataset name.

Product Availability

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

Parameters:

subdatasetID - The subdatasetID (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubdatasetDescription

String getSubdatasetDescription(int subdatasetID)
                                throws IOException,
                                       AutomationException

The given subdataset description.

Product Availability

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

Parameters:

subdatasetID - The subdatasetID (in)

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.