com.esri.arcgis.datasourcesraster
Interface IDefineOverviewsParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefineOverviewsParameters, IDefineOverviewsParametersProxy

public interface IDefineOverviewsParameters
extends Serializable

Provides access to members that control parameters for define overviews of a mosaic dataset.

Product Availability

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

Method Summary

int	getInstanceID() The object ID of the raster type instance associated with a preview define overview operation.
boolean	isForceOverviewTiles() Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.
boolean	isRefreshAllInstances() Indicates whether all existing overview instances are refreshed.
void	setForceOverviewTiles(boolean pbForceOverviewTiles) Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.
void	setInstanceID(int pInstanceID) The object ID of the raster type instance associated with a preview define overview operation.
void	setRefreshAllInstances(boolean pbRefreshAllInstances) Indicates whether all existing overview instances are refreshed.

Method Detail

setForceOverviewTiles

void setForceOverviewTiles(boolean pbForceOverviewTiles)
                           throws IOException,
                                  AutomationException

Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.

Product Availability

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

Parameters:

pbForceOverviewTiles - The pbForceOverviewTiles (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isForceOverviewTiles

boolean isForceOverviewTiles()
                             throws IOException,
                                    AutomationException

Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.

Product Availability

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

Returns:

The pbForceOverviewTiles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInstanceID

void setInstanceID(int pInstanceID)
                   throws IOException,
                          AutomationException

The object ID of the raster type instance associated with a preview define overview operation. Properties that control how overview tiles are created are read from the matching raster type instance. A value here also indicates that no new schema is created by ????&

Product Availability

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

Parameters:

pInstanceID - The pInstanceID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInstanceID

int getInstanceID()
                  throws IOException,
                         AutomationException

The object ID of the raster type instance associated with a preview define overview operation. Properties that control how overview tiles are created are read from the matching raster type instance. A value here also indicates that no new schema is created by ????&

Product Availability

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

Returns:

The pInstanceID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshAllInstances

void setRefreshAllInstances(boolean pbRefreshAllInstances)
                            throws IOException,
                                   AutomationException

Indicates whether all existing overview instances are refreshed. A TRUE value also indicates that no new schema of overview tiles is created by the IMosaicDatasetOperation.DefineOverviews method.

Product Availability

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

Parameters:

pbRefreshAllInstances - The pbRefreshAllInstances (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRefreshAllInstances

boolean isRefreshAllInstances()
                              throws IOException,
                                     AutomationException

Indicates whether all existing overview instances are refreshed. A TRUE value also indicates that no new schema of overview tiles is created by the IMosaicDatasetOperation.DefineOverviews method.

Product Availability

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

Returns:

The pbRefreshAllInstances

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.