com.esri.arcgis.datasourcesraster
Interface IOverviewTileParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefineOverviewsParameters, IOverviewTileParametersProxy

public interface IOverviewTileParameters
extends Serializable

Provides access to members that control overview tile parameters.

Product Availability

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

Method Summary

IGeometry	getAoiGeometry() The polygon within which overview tiles are created.
double	getCellSize() The cell size of the first level of overview tiles.
int	getLevels() The number of levels of overview tiles created.
int	getMaximumSizeOfTopmostOverview() The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
IPoint	getOrigin() The origin of the grid containing overview tiles.
int	getOverviewFactor() The factor by which two neighboring overview levels differ.
int	getTileCols() The recommended number of pixel columns in each overview tiles.
int	getTileRows() The recommended number of pixel rows in each overview tiles.
IWorkspaceName	getWorkspaceName() The workspace name where overview raster datasets are generated and stored.
void	setAoiGeometryByRef(IGeometry ppAoiGeometry) The polygon within which overview tiles are created.
void	setCellSize(double pCellsize) The cell size of the first level of overview tiles.
void	setLevels(int pLevels) The number of levels of overview tiles created.
void	setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview) The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
void	setOriginByRef(IPoint ppOrigin) The origin of the grid containing overview tiles.
void	setOverviewFactor(int pOverviewFactor) The factor by which two neighboring overview levels differ.
void	setTileCols(int pTileColPixels) The recommended number of pixel columns in each overview tiles.
void	setTileRows(int pTileRowPixels) The recommended number of pixel rows in each overview tiles.
void	setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName) The workspace name where overview raster datasets are generated and stored.

Method Detail

setAoiGeometryByRef

void setAoiGeometryByRef(IGeometry ppAoiGeometry)
                         throws IOException,
                                AutomationException

The polygon within which overview tiles are created.

Product Availability

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

Parameters:

ppAoiGeometry - 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.

getAoiGeometry

IGeometry getAoiGeometry()
                         throws IOException,
                                AutomationException

The polygon within which overview tiles are created.

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.

setOriginByRef

void setOriginByRef(IPoint ppOrigin)
                    throws IOException,
                           AutomationException

The origin of the grid containing overview tiles.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrigin

IPoint getOrigin()
                 throws IOException,
                        AutomationException

The origin of the grid containing overview tiles.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSize

void setCellSize(double pCellsize)
                 throws IOException,
                        AutomationException

The cell size of the first level of overview tiles.

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.

getCellSize

double getCellSize()
                   throws IOException,
                          AutomationException

The cell size of the first level of overview tiles.

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.

setTileCols

void setTileCols(int pTileColPixels)
                 throws IOException,
                        AutomationException

The recommended number of pixel columns in each overview tiles.

Product Availability

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

Parameters:

pTileColPixels - The pTileColPixels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileCols

int getTileCols()
                throws IOException,
                       AutomationException

The recommended number of pixel columns in each overview tiles.

Product Availability

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

Returns:

The pTileColPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRows

void setTileRows(int pTileRowPixels)
                 throws IOException,
                        AutomationException

The recommended number of pixel rows in each overview tiles.

Product Availability

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

Parameters:

pTileRowPixels - The pTileRowPixels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRows

int getTileRows()
                throws IOException,
                       AutomationException

The recommended number of pixel rows in each overview tiles.

Product Availability

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

Returns:

The pTileRowPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevels

void setLevels(int pLevels)
               throws IOException,
                      AutomationException

The number of levels of overview tiles created.

Product Availability

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

Parameters:

pLevels - The pLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevels

int getLevels()
              throws IOException,
                     AutomationException

The number of levels of overview tiles created.

Product Availability

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

Returns:

The pLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverviewFactor

void setOverviewFactor(int pOverviewFactor)
                       throws IOException,
                              AutomationException

The factor by which two neighboring overview levels differ.

Product Availability

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

Parameters:

pOverviewFactor - The pOverviewFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverviewFactor

int getOverviewFactor()
                      throws IOException,
                             AutomationException

The factor by which two neighboring overview levels differ.

Product Availability

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

Returns:

The pOverviewFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumSizeOfTopmostOverview

void setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview)
                                     throws IOException,
                                            AutomationException

The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews.

Product Availability

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

Parameters:

pMaximumSizeOfTopmostOverview - The pMaximumSizeOfTopmostOverview (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumSizeOfTopmostOverview

int getMaximumSizeOfTopmostOverview()
                                    throws IOException,
                                           AutomationException

The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews.

Product Availability

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

Returns:

The pMaximumSizeOfTopmostOverview

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

void setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName)
                           throws IOException,
                                  AutomationException

The workspace name where overview raster datasets are generated and stored.

Product Availability

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

Parameters:

ppOverviewWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

The workspace name where overview raster datasets are generated and stored.

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.