com.esri.arcgis.datasourcesraster
Interface IMosaicDataset

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMosaicDataset2

All Known Implementing Classes:

IMosaicDatasetProxy, MosaicDataset

public interface IMosaicDataset
extends Serializable

Provides access to members that control a mosaic dataset.

Product Availability

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

Method Summary

void	applyFunction(IRasterFunction pFunction, Object pArguments, String name) Applies a given function to this mosaic dataset on top of all existing functions.
void	clearFunction() Clears all functions appied to this mosaic dataset.
IFeatureClass	getBoundary() The associated boundary.
IGeometry	getBoundaryGeometry() The associated boundary as a geometry.
IFeatureClass	getCatalog() The catalog.
int	getCatalogType() The raster catalog type.
IEnumName	getChildren() The mosaic dataset owned tables.
double	getDeviceDpi() The device DPI.
ITable	getDodgingTable() The associated color correction table.
ITable	getLevelsTable() The associated cell size levels table.
ITable	getLogTable() The associated log table.
IMosaicFunction	getMosaicFunction() The mosaic function.
IMosaicFunctionArguments	getMosaicFunctionArguments() The mosaic function arguments.
ITable	getOverviewTable() The associated overview table.
ITable	getRasterTypeTable() The associated raster types.
String	getRelativePath() The msoaic dataset's relative path.
IFeatureClass	getSeamline() The associated seamline table.
ITable	getStereoTable() The associated stereo table.
String	getVisibleFields() The visible fields in a mosaic dataset
boolean	isReferenced() Indicates if this is a referenced mosaic dataset.
void	setDeviceDpi(double pDpi) The device DPI.
void	setLevelsTableByRef(ITable ppLevelsTable) The associated cell size levels table.
void	setLogTableByRef(ITable ppLogTable) The associated log table.
void	setOverviewTableByRef(ITable ppOverviewTable) The associated overview table.
void	setRasterTypeTableByRef(ITable ppRasterTypeTable) The associated raster types.
void	setReferenced(boolean pReferenced) Indicates if this is a referenced mosaic dataset.
void	setRelativePath(String pPath) The msoaic dataset's relative path.

Method Detail

getCatalog

IFeatureClass getCatalog()
                         throws IOException,
                                AutomationException

The catalog.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeviceDpi

void setDeviceDpi(double pDpi)
                  throws IOException,
                         AutomationException

The device DPI.

Product Availability

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

Parameters:

pDpi - The pDpi (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeviceDpi

double getDeviceDpi()
                    throws IOException,
                           AutomationException

The device DPI.

Product Availability

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

Returns:

The pDpi

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReferenced

boolean isReferenced()
                     throws IOException,
                            AutomationException

Indicates if this is a referenced mosaic dataset.

Product Availability

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

Returns:

The pReferenced

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenced

void setReferenced(boolean pReferenced)
                   throws IOException,
                          AutomationException

Indicates if this is a referenced mosaic dataset.

Product Availability

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

Parameters:

pReferenced - The pReferenced (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalogType

int getCatalogType()
                   throws IOException,
                          AutomationException

The raster catalog type.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterCatalogType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundary

IFeatureClass getBoundary()
                          throws IOException,
                                 AutomationException

The associated boundary.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundaryGeometry

IGeometry getBoundaryGeometry()
                              throws IOException,
                                     AutomationException

The associated boundary as a geometry.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeamline

IFeatureClass getSeamline()
                          throws IOException,
                                 AutomationException

The associated seamline table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStereoTable

ITable getStereoTable()
                      throws IOException,
                             AutomationException

The associated stereo table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDodgingTable

ITable getDodgingTable()
                       throws IOException,
                              AutomationException

The associated color correction table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterTypeTable

ITable getRasterTypeTable()
                          throws IOException,
                                 AutomationException

The associated raster types.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterTypeTableByRef

void setRasterTypeTableByRef(ITable ppRasterTypeTable)
                             throws IOException,
                                    AutomationException

The associated raster types.

Product Availability

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

Parameters:

ppRasterTypeTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverviewTable

ITable getOverviewTable()
                        throws IOException,
                               AutomationException

The associated overview table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverviewTableByRef

void setOverviewTableByRef(ITable ppOverviewTable)
                           throws IOException,
                                  AutomationException

The associated overview table.

Product Availability

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

Parameters:

ppOverviewTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogTable

ITable getLogTable()
                   throws IOException,
                          AutomationException

The associated log table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogTableByRef

void setLogTableByRef(ITable ppLogTable)
                      throws IOException,
                             AutomationException

The associated log table.

Product Availability

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

Parameters:

ppLogTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevelsTable

ITable getLevelsTable()
                      throws IOException,
                             AutomationException

The associated cell size levels table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevelsTableByRef

void setLevelsTableByRef(ITable ppLevelsTable)
                         throws IOException,
                                AutomationException

The associated cell size levels table.

Product Availability

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

Parameters:

ppLevelsTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibleFields

String getVisibleFields()
                        throws IOException,
                               AutomationException

The visible fields in a mosaic dataset

Product Availability

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

Returns:

The pVisibleFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

IEnumName getChildren()
                      throws IOException,
                             AutomationException

The mosaic dataset owned tables.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IEnumName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicFunction

IMosaicFunction getMosaicFunction()
                                  throws IOException,
                                         AutomationException

The mosaic function.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicFunctionArguments

IMosaicFunctionArguments getMosaicFunctionArguments()
                                                    throws IOException,
                                                           AutomationException

The mosaic function arguments.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyFunction

void applyFunction(IRasterFunction pFunction,
                   Object pArguments,
                   String name)
                   throws IOException,
                          AutomationException

Applies a given function to this mosaic dataset on top of all existing functions.

Product Availability

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

Parameters:

pFunction - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)

pArguments - A reference to another Object (IUnknown) (in)

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearFunction

void clearFunction()
                   throws IOException,
                          AutomationException

Clears all functions appied to this mosaic dataset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelativePath

String getRelativePath()
                       throws IOException,
                              AutomationException

The msoaic dataset's relative path.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativePath

void setRelativePath(String pPath)
                     throws IOException,
                            AutomationException

The msoaic dataset's relative path.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.