com.esri.arcgis.carto
Interface ITileCacheInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

TileCacheInfo

public interface ITileCacheInfo
extends Serializable

Provides access to members that provide the tile cache info.

When To Use

Using the tiling scheme information in the TileCacheInfo object the client can calculate the tiles that cover any rectangular extent in map space and then retrieve tiles either directly from the virtual directory, or from the tile handler or by making GetMapTile or GetLayerTile requests against the map service.

Product Availability

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

Method Summary

void	computeResolutions() Computes resolutions from scales and current DPI.
void	computeScales() Computes scales from resolutions and current DPI.
int	getDpi() The tiling DPI.
ILODInfos	getLODInfos() The tile cache Levels Of Details.
IPoint	getOrigin() The tiling origin.
ISpatialReference	getSpatialReference() The tiling spatial reference.
int	getTileCols() The number of columns per tile.
int	getTileRows() The number of rows per tile.
void	setDpi(int pDpi) The tiling DPI.
void	setLODInfosByRef(ILODInfos ppLODInfos) The tile cache Levels Of Details.
void	setOrigin(IPoint ppOrigin) The tiling origin.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The tiling spatial reference.
void	setTileCols(int pNumTileCols) The number of columns per tile.
void	setTileRows(int pNumTileRows) The number of rows per tile.

Method Detail

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The tiling spatial reference.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws IOException,
                                     AutomationException

The tiling spatial reference.

Product Availability

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

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrigin

IPoint getOrigin()
                 throws IOException,
                        AutomationException

The tiling origin.

Remarks

The tiling origin is in map space, and it is the same for all levels of detail (LODs).

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.

setOrigin

void setOrigin(IPoint ppOrigin)
               throws IOException,
                      AutomationException

The tiling origin.

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.

getTileCols

int getTileCols()
                throws IOException,
                       AutomationException

The number of columns per tile.

Product Availability

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

Returns:

The pNumTileCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileCols

void setTileCols(int pNumTileCols)
                 throws IOException,
                        AutomationException

The number of columns per tile.

Product Availability

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

Parameters:

pNumTileCols - The pNumTileCols (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRows

int getTileRows()
                throws IOException,
                       AutomationException

The number of rows per tile.

Product Availability

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

Returns:

The pNumTileRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRows

void setTileRows(int pNumTileRows)
                 throws IOException,
                        AutomationException

The number of rows per tile.

Product Availability

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

Parameters:

pNumTileRows - The pNumTileRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDpi

int getDpi()
           throws IOException,
                  AutomationException

The tiling 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.

setDpi

void setDpi(int pDpi)
            throws IOException,
                   AutomationException

The tiling 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.

getLODInfos

ILODInfos getLODInfos()
                      throws IOException,
                             AutomationException

The tile cache Levels Of Details.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.ILODInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLODInfosByRef

void setLODInfosByRef(ILODInfos ppLODInfos)
                      throws IOException,
                             AutomationException

The tile cache Levels Of Details.

Product Availability

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

Parameters:

ppLODInfos - A reference to a com.esri.arcgis.carto.ILODInfos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeResolutions

void computeResolutions()
                        throws IOException,
                               AutomationException

Computes resolutions from scales and current DPI.

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.

computeScales

void computeScales()
                   throws IOException,
                          AutomationException

Computes scales from resolutions and current DPI.

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.