com.esri.arcgis.geodatabase
Interface IRasterDataset

All Superinterfaces:
Serializable
All Known Subinterfaces:
IRasterDataset2, IRasterDataset3
All Known Implementing Classes:
IRasterDatasetProxy, RasterBand, RasterDataset

public interface IRasterDataset
extends Serializable

Provides access to members that control a raster dataset.

Superseded By

IRasterDataset3

Remarks

The IRasterDataset interface provides basic access to the properties of a raster dataset such as format, compression type etc. It also allows to create a Raster object of the raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean canCopy()
          Returns true if this dataset can be copied.
 IDataset copy(String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 IRaster createDefaultRaster()
          Creates a raster object with the default properties for this dataset.
 String getCompleteName()
          The full path of the RasterDataset.
 String getCompressionType()
          The compression technique applied to this RasterDataset.
 String getFormat()
          The format of this RasterRataset.
 String getSensorType()
          The sensor type used for this RasterDataset.
 void precalculateStats(Object index_list)
          Calculates statistics and histograms for specified bands.
 

Method Detail

getFormat

String getFormat()
                 throws IOException,
                        AutomationException
The format of this RasterRataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The format
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSensorType

String getSensorType()
                     throws IOException,
                            AutomationException
The sensor type used for this RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The sensorType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompressionType

String getCompressionType()
                          throws IOException,
                                 AutomationException
The compression technique applied to this RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The comp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createDefaultRaster

IRaster createDefaultRaster()
                            throws IOException,
                                   AutomationException
Creates a raster object with the default properties for this dataset.

Remarks

The CreateDefaultRaster method creates a Raster that has a square cell size and contains only three raster bands if the dataset has more than three bands. The three bands are the default bands used in raster RGB renderer and are determined by the settings for default raster behavior made on the RasterDefaultsEnv object in esriCarto library.

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.

canCopy

boolean canCopy()
                throws IOException,
                       AutomationException
Returns true if this dataset can be copied.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The canCopy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

IDataset copy(String copyName,
              IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
copyName - The copyName (in)
copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

precalculateStats

void precalculateStats(Object index_list)
                       throws IOException,
                              AutomationException
Calculates statistics and histograms for specified bands.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index_list - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompleteName

String getCompleteName()
                       throws IOException,
                              AutomationException
The full path of the RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The completeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.