com.esri.arcgis.datasourcesraster
Interface ICreateMosaicDatasetParameters

All Superinterfaces:
Serializable
All Known Implementing Classes:
CreateMosaicDatasetParameters, ICreateMosaicDatasetParametersProxy

public interface ICreateMosaicDatasetParameters
extends Serializable

Provides access to members that control mosaic dataset creation parameters.

Description

This interface provides access to parameters that control the creation of a new Mosaic Dataset or a referenced Mosaic Dataset.

Product Availability

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


Method Summary
 int getBandCount()
          The number of bands in the mosaic dataset.
 IFIDSet getDefinitionFIDs()
          The definition selection set on the source catalog.
 IGeometry getDefinitionGeometry()
          The definition (spatial selection) geometry on the source catalog.
 String getLODFieldName()
          The name of the field that contains scale values for items in the mosaic dataset.
 IMosaicLODInfos getLODInfos()
          The levels of detail associated with the mosaic dataset.
 String getMaxCellsizeFieldName()
          The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.
 double getMaximumVisibleCellsize()
          The cell-size value above which no mosaicking occurs.
 String getMinCellsizeFieldName()
          The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.
 int getPixelType()
          The pixel-type of the mosaic dataset.
 void setBandCount(int pCount)
          The number of bands in the mosaic dataset.
 void setDefinitionFIDsByRef(IFIDSet ppFIDs)
          The definition selection set on the source catalog.
 void setDefinitionGeometryByRef(IGeometry ppGeometry)
          The definition (spatial selection) geometry on the source catalog.
 void setLODFieldName(String pLODFieldName)
          The name of the field that contains scale values for items in the mosaic dataset.
 void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
          The levels of detail associated with the mosaic dataset.
 void setMaxCellsizeFieldName(String pMaxCellsizeFieldName)
          The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.
 void setMaximumVisibleCellsize(double pCellsize)
          The cell-size value above which no mosaicking occurs.
 void setMinCellsizeFieldName(String pMinCellsizeFieldName)
          The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.
 void setPixelType(int pPixelType)
          The pixel-type of the mosaic dataset.
 

Method Detail

setDefinitionGeometryByRef

void setDefinitionGeometryByRef(IGeometry ppGeometry)
                                throws IOException,
                                       AutomationException
The definition (spatial selection) geometry on the source catalog.

Product Availability

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

Parameters:
ppGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionGeometry

IGeometry getDefinitionGeometry()
                                throws IOException,
                                       AutomationException
The definition (spatial selection) geometry on the source catalog.

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.

setMaximumVisibleCellsize

void setMaximumVisibleCellsize(double pCellsize)
                               throws IOException,
                                      AutomationException
The cell-size value above which no mosaicking occurs.

Description

Maximum resolution above which the mosaiced rasters are displayed as rasterized wireframes in a referenced Mosaic Dataset.

Product Availability

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

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

getMaximumVisibleCellsize

double getMaximumVisibleCellsize()
                                 throws IOException,
                                        AutomationException
The cell-size value above which no mosaicking occurs.

Description

Maximum resolution above which the mosaiced rasters are displayed as rasterized wireframes in a referenced Mosaic Dataset.

Product Availability

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

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

setLODInfosByRef

void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
                      throws IOException,
                             AutomationException
The levels of detail associated with the mosaic dataset.

Description

This object describes LOD (Level Of Detail) information for the Mosaic Dataset. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

Parameters:
ppLODInfos - A reference to a com.esri.arcgis.datasourcesraster.IMosaicLODInfos (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLODInfos

IMosaicLODInfos getLODInfos()
                            throws IOException,
                                   AutomationException
The levels of detail associated with the mosaic dataset.

Description

This object describes LOD (Level Of Detail) information for the Mosaic Dataset. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.datasourcesraster.IMosaicLODInfos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelType

void setPixelType(int pPixelType)
                  throws IOException,
                         AutomationException
The pixel-type of the mosaic dataset.

Description

Pixel Type of the Mosaic Dataset to be created.

Product Availability

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

Parameters:
pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException
The pixel-type of the mosaic dataset.

Description

Pixel Type of the Mosaic Dataset to be created.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBandCount

void setBandCount(int pCount)
                  throws IOException,
                         AutomationException
The number of bands in the mosaic dataset.

Description

Number of bands of the Mosaic Dataset to be created.

Product Availability

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

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

getBandCount

int getBandCount()
                 throws IOException,
                        AutomationException
The number of bands in the mosaic dataset.

Description

Number of bands of the Mosaic Dataset to be created.

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.

setMinCellsizeFieldName

void setMinCellsizeFieldName(String pMinCellsizeFieldName)
                             throws IOException,
                                    AutomationException
The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the minimum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

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

getMinCellsizeFieldName

String getMinCellsizeFieldName()
                               throws IOException,
                                      AutomationException
The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the minimum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

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

setMaxCellsizeFieldName

void setMaxCellsizeFieldName(String pMaxCellsizeFieldName)
                             throws IOException,
                                    AutomationException
The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the maximum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

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

getMaxCellsizeFieldName

String getMaxCellsizeFieldName()
                               throws IOException,
                                      AutomationException
The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the maximum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

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

setLODFieldName

void setLODFieldName(String pLODFieldName)
                     throws IOException,
                            AutomationException
The name of the field that contains scale values for items in the mosaic dataset.

Description

Field name that corresponds to a field in a Military Analyst catalog that describes the LOD (Level Of Detail) for each raster. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

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

getLODFieldName

String getLODFieldName()
                       throws IOException,
                              AutomationException
The name of the field that contains scale values for items in the mosaic dataset.

Description

Field name that corresponds to a field in a Military Analyst catalog that describes the LOD (Level Of Detail) for each raster. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

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

setDefinitionFIDsByRef

void setDefinitionFIDsByRef(IFIDSet ppFIDs)
                            throws IOException,
                                   AutomationException
The definition selection set on the source catalog.

Product Availability

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

Parameters:
ppFIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionFIDs

IFIDSet getDefinitionFIDs()
                          throws IOException,
                                 AutomationException
The definition selection set on the source catalog.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.