com.esri.arcgis.datasourcesraster
Interface IMosaicDatasetOperation

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMosaicDatasetOperation2

All Known Implementing Classes:

IMosaicDatasetOperationProxy, MosaicDataset

public interface IMosaicDatasetOperation
extends Serializable

Provides access to additional members that control a moasaic definition

Product Availability

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

Method Summary

void	addNewerRasters(ISelectionParameters pSelectionParameters, ITrackCancel pTrackCancel) Re-crawls all data source paths associated with selected catalog items for newer data sources and adds these new items to the mosaic dataset.
void	addRasters(IAddRastersParameters pParameters, ITrackCancel pTrackCancel) Adds raster datasets to the mosaic dataset.
void	buildBoundary(IBuildBoundaryParameters pParameters, ITrackCancel pTrackCancel) Builds the boundary geometry of the mosaic dataset using selected catalog items.
void	buildFootprints(IBuildFootprintsParameters pParameters, ITrackCancel pTrackCancel) Rebuilds footprint geometry of selected catalog items.
void	buildSeamlines(IBuildSeamlinesParameters pParameters, ITrackCancel pTrackCancel) Builds seamline geometry of selected catalog items.
void	calculateCellSizeRanges(ICalculateCellSizeRangesParameters pParameters, ITrackCancel pTrackCancel) Calculates cell size ranges that control visibility of selected catalog items.
void	computeDirtyArea(IComputeDirtyAreaParameters pParameters, ITrackCancel pTrackCancel) Computes a polygon that defines a region containing mosaic dataset items newer than a specified point in time.
void	defineNoData(IDefineNoDataParameters pParameters, ITrackCancel pTrackCancel) Applies a mask with specified NoData values on selected catalog items.
void	defineOverviews(IDefineOverviewsParameters pParameters, ITrackCancel pTrackCancel) Defines a new (or refreshes an existing) overview tiling scheme.
void	generateOverviews(IGenerateOverviewsParameters pParameters, ITrackCancel pTrackCancel) Generates overview images corresponding to selected catalog items.
ICellSizeLevels	getCellSizeLevels(int instanceID) Returns the cell size levels associated with the specified raster type instance.
IWorkspaceName	getDefaultOverviewWorkspace() The default workspace for storing overview raster dataset associated with the mosaic dataset.
void	importGeometry(IImportGeometryParameters pParameters, ITrackCancel pTrackCancel) Imports external geometry into the mosaic dataset.
void	querySpatialIndex(IIndex[] ppSpatialIndex, double[] pGridSize1, double[] pGridSize2, double[] pGridSize3) Returns the spatial index and grid sizes of the mosaic catalog.
void	removeItems(IRemoveItemsParameters pParameters, ITrackCancel pTrackCancel) Removes selected catalog items.
void	replacePaths(IReplacePathsParameters pParameters, ITrackCancel pTrackCancel) Replaces paths associated with the raster datasets and the data sources of selected catalog items.
void	resetSpatialIndex(double gridSize1, double gridSize2, double gridSize3) Resets spatial index on the mosaic catalog.
ICursor	search(ISelectionParameters pParameters, IQueryFilter pAdditionalQuery) Returns a search cursor with mosaic dataset items matching all specified criteria.
void	synchronize(ISynchronizeParameters pParameters, ITrackCancel pTrackCancel) Rebuilds selected catalog items and synchronizes them with the corresponding data source.
void	updateCellSizeLevels(int instanceID, ICellSizeLevels pCellSizeLevels) Stores the cell size levels associated with the specified raster type instance ID.
void	updateTimeStamp(ISelectionParameters pParameters, ITrackCancel pTrackCancel) Updates the time stamp value of selected catalog items.

Method Detail

addRasters

void addRasters(IAddRastersParameters pParameters,
                ITrackCancel pTrackCancel)
                throws IOException,
                       AutomationException

Adds raster datasets to the mosaic dataset.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IAddRastersParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronize

void synchronize(ISynchronizeParameters pParameters,
                 ITrackCancel pTrackCancel)
                 throws IOException,
                        AutomationException

Rebuilds selected catalog items and synchronizes them with the corresponding data source.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.ISynchronizeParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateCellSizeRanges

void calculateCellSizeRanges(ICalculateCellSizeRangesParameters pParameters,
                             ITrackCancel pTrackCancel)
                             throws IOException,
                                    AutomationException

Calculates cell size ranges that control visibility of selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.ICalculateCellSizeRangesParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildBoundary

void buildBoundary(IBuildBoundaryParameters pParameters,
                   ITrackCancel pTrackCancel)
                   throws IOException,
                          AutomationException

Builds the boundary geometry of the mosaic dataset using selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IBuildBoundaryParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

defineOverviews

void defineOverviews(IDefineOverviewsParameters pParameters,
                     ITrackCancel pTrackCancel)
                     throws IOException,
                            AutomationException

Defines a new (or refreshes an existing) overview tiling scheme.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IDefineOverviewsParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateOverviews

void generateOverviews(IGenerateOverviewsParameters pParameters,
                       ITrackCancel pTrackCancel)
                       throws IOException,
                              AutomationException

Generates overview images corresponding to selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IGenerateOverviewsParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeItems

void removeItems(IRemoveItemsParameters pParameters,
                 ITrackCancel pTrackCancel)
                 throws IOException,
                        AutomationException

Removes selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRemoveItemsParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildFootprints

void buildFootprints(IBuildFootprintsParameters pParameters,
                     ITrackCancel pTrackCancel)
                     throws IOException,
                            AutomationException

Rebuilds footprint geometry of selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IBuildFootprintsParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildSeamlines

void buildSeamlines(IBuildSeamlinesParameters pParameters,
                    ITrackCancel pTrackCancel)
                    throws IOException,
                           AutomationException

Builds seamline geometry of selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IBuildSeamlinesParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replacePaths

void replacePaths(IReplacePathsParameters pParameters,
                  ITrackCancel pTrackCancel)
                  throws IOException,
                         AutomationException

Replaces paths associated with the raster datasets and the data sources of selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IReplacePathsParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

defineNoData

void defineNoData(IDefineNoDataParameters pParameters,
                  ITrackCancel pTrackCancel)
                  throws IOException,
                         AutomationException

Applies a mask with specified NoData values on selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IDefineNoDataParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeDirtyArea

void computeDirtyArea(IComputeDirtyAreaParameters pParameters,
                      ITrackCancel pTrackCancel)
                      throws IOException,
                             AutomationException

Computes a polygon that defines a region containing mosaic dataset items newer than a specified point in time.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IComputeDirtyAreaParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

querySpatialIndex

void querySpatialIndex(IIndex[] ppSpatialIndex,
                       double[] pGridSize1,
                       double[] pGridSize2,
                       double[] pGridSize3)
                       throws IOException,
                              AutomationException

Returns the spatial index and grid sizes of the mosaic catalog.

Product Availability

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

Parameters:

ppSpatialIndex - A reference to a com.esri.arcgis.geodatabase.IIndex (out: use single element array)

pGridSize1 - The pGridSize1 (out: use single element array)

pGridSize2 - The pGridSize2 (out: use single element array)

pGridSize3 - The pGridSize3 (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetSpatialIndex

void resetSpatialIndex(double gridSize1,
                       double gridSize2,
                       double gridSize3)
                       throws IOException,
                              AutomationException

Resets spatial index on the mosaic catalog. Creates a new spatial index if none is found.

Product Availability

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

Parameters:

gridSize1 - The gridSize1 (in)

gridSize2 - The gridSize2 (in)

gridSize3 - The gridSize3 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTimeStamp

void updateTimeStamp(ISelectionParameters pParameters,
                     ITrackCancel pTrackCancel)
                     throws IOException,
                            AutomationException

Updates the time stamp value of selected catalog items.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.ISelectionParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importGeometry

void importGeometry(IImportGeometryParameters pParameters,
                    ITrackCancel pTrackCancel)
                    throws IOException,
                           AutomationException

Imports external geometry into the mosaic dataset.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IImportGeometryParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOverviewWorkspace

IWorkspaceName getDefaultOverviewWorkspace()
                                           throws IOException,
                                                  AutomationException

The default workspace for storing overview raster dataset associated with the mosaic dataset.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

search

ICursor search(ISelectionParameters pParameters,
               IQueryFilter pAdditionalQuery)
               throws IOException,
                      AutomationException

Returns a search cursor with mosaic dataset items matching all specified criteria.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.ISelectionParameters (in)

pAdditionalQuery - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNewerRasters

void addNewerRasters(ISelectionParameters pSelectionParameters,
                     ITrackCancel pTrackCancel)
                     throws IOException,
                            AutomationException

Re-crawls all data source paths associated with selected catalog items for newer data sources and adds these new items to the mosaic dataset.

Product Availability

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

Parameters:

pSelectionParameters - A reference to a com.esri.arcgis.datasourcesraster.ISelectionParameters (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSizeLevels

ICellSizeLevels getCellSizeLevels(int instanceID)
                                  throws IOException,
                                         AutomationException

Returns the cell size levels associated with the specified raster type instance. An 'instanceID' value of -1 indicates a request for cell size levels associated with the mosaic dataset.

Product Availability

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

Parameters:

instanceID - The instanceID (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.ICellSizeLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateCellSizeLevels

void updateCellSizeLevels(int instanceID,
                          ICellSizeLevels pCellSizeLevels)
                          throws IOException,
                                 AutomationException

Stores the cell size levels associated with the specified raster type instance ID. An 'instanceID' value of -1 indicates that cell size levels associated with the mosaic dataset is being updated.

Product Availability

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

Parameters:

instanceID - The instanceID (in)

pCellSizeLevels - A reference to a com.esri.arcgis.datasourcesraster.ICellSizeLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.