com.esri.arcgis.geodatabase
Interface IRasterWorkspace2

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRasterWorkspace2Proxy, RasterWorkspace

public interface IRasterWorkspace2
extends Serializable

Provides access to members that control an improved raster workspace.

Remarks

IRasterWorspace2 is used to access a raster stored in a file system in any supported raster format. To access raster from geodtabase, use IRasterWorkspaceEx interface.

When To Use

IRasterWorkspace2 interface allows to create a raster dataset in addition to the functionalities provided by the IRasterWorkspace interface.

Product Availability

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

Method Summary

boolean	canCopy() Indicates if this dataset can be copied.
IDataset	copy(String copyName, IWorkspace copyWorkspace) Copies this workspace to a new workspace with the specified name.
IRasterDataset	createRasterDataset(String name, String format, IPoint origin, int columnCount, int rowCount, double cellSizeX, double cellSizeY, int numBands, int pixelType, ISpatialReference spatialReference, boolean permanent) Creates a RasterDataset in the workspace given its name.
boolean	isWorkspace(String name) Indicates if the file path specified is a raster workspace.
IRasterDataset	openRasterDataset(String name) Opens a RasterDataset in the workspace given its name.

Method Detail

openRasterDataset

IRasterDataset openRasterDataset(String name)
                                 throws IOException,
                                        AutomationException

Opens a RasterDataset in the workspace given its name.

Remarks

OpenRasterDataset opens a RasterDataset from a supported file based raster format, such as GRID, Imagine, BMP, TIFF, etc.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

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.

createRasterDataset

IRasterDataset createRasterDataset(String name,
                                   String format,
                                   IPoint origin,
                                   int columnCount,
                                   int rowCount,
                                   double cellSizeX,
                                   double cellSizeY,
                                   int numBands,
                                   int pixelType,
                                   ISpatialReference spatialReference,
                                   boolean permanent)
                                   throws IOException,
                                          AutomationException

Creates a RasterDataset in the workspace given its name.

Remarks

CreateRasterDataset creates a file based raster dataset, the origin, width, and height of the raster dataset must be specified along with other required parameters, the raster dataset with the specified dimension and default pixel values will be created . The default pixel values of the raster dataset can be modified by writting pixel blocks to the dataset or mosaicking.

CreateRasterDataset can be used to create GRID, TIFF, ERDAS Imagine,BMP, Idrisi format, and in memory raster. The strings used to specify formats are "GRID", "TIFF", "IMAGINE Image", "BMP", "RST", and "MEM" respectively. The strings are case-sensitive.

For GRID format, CreateRasterDataset only allows square cell size.

When creating an in memory raster, the file name can be an empty string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

format - The format (in)

origin - A reference to a com.esri.arcgis.geometry.IPoint (in)

columnCount - The columnCount (in)

rowCount - The rowCount (in)

cellSizeX - The cellSizeX (in)

cellSizeY - The cellSizeY (in)

numBands - The numBands (in)

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

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in, optional, pass 0 if not required)

permanent - The permanent (in, optional, pass true if not required)

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.

isWorkspace

boolean isWorkspace(String name)
                    throws IOException,
                           AutomationException

Indicates if the file path specified is a raster workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Returns:

The isWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCopy

boolean canCopy()
                throws IOException,
                       AutomationException

Indicates 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 workspace to a new workspace with the specified name.

Remarks

Not implemented.

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.