com.esri.arcgis.carto
Interface IImageCooker

All Superinterfaces:

Serializable

All Known Implementing Classes:

ImageCooker

public interface IImageCooker
extends Serializable

AIS cache reader object.

Product Availability

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

Method Summary

void	clear(IEnvelope pExtent, ITrackCancel pTrackCancel) Clears cache tiles with a given extent.
void	connect(String location, IImageServer pImageServer) Connects an image server object to its cache location.
void	getCacheDirectory(String[] pCacheDir) Gets the cache directory/location.
double	getMaximumImageCellsize() The maximum source image cellsize below which data are available.
IName	getServerObjectName() The ArcGIS server object to run the image cooker.
int	getThreadCount() The number of Image Cooker instances for building tile cache.
byte[]	getTile(int level, int row, int column) Gets a tile at a given LOD, and column and row location.
void	putTile(int level, int row, int column, byte[] ppTile) Puts a tile at a given LOD, and column and row location.
void	setMaximumImageCellsize(double pMaxPS) The maximum source image cellsize below which data are available.
void	setServerObjectNameByRef(IName ppName) The ArcGIS server object to run the image cooker.
void	setThreadCount(int pThreadCount) The number of Image Cooker instances for building tile cache.
void	update(IImageServer pImageServer, IEnvelope pExtent, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Updates cache within a given extent.
void	updateByGeometry(IImageServer pImageServer, IGeometry pGeometry, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Updates cache within an area of interest defined by a given geometry.

Method Detail

connect

void connect(String location,
             IImageServer pImageServer)
             throws IOException,
                    AutomationException

Connects an image server object to its cache location.

Product Availability

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

Parameters:

location - The location (in)

pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear(IEnvelope pExtent,
           ITrackCancel pTrackCancel)
           throws IOException,
                  AutomationException

Clears cache tiles with a given extent.

Product Availability

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

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTile

byte[] getTile(int level,
               int row,
               int column)
               throws IOException,
                      AutomationException

Gets a tile at a given LOD, and column and row location.

Product Availability

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

Parameters:

level - The level (in)

row - The row (in)

column - The column (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putTile

void putTile(int level,
             int row,
             int column,
             byte[] ppTile)
             throws IOException,
                    AutomationException

Puts a tile at a given LOD, and column and row location.

Product Availability

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

Parameters:

level - The level (in)

row - The row (in)

column - The column (in)

ppTile - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheDirectory

void getCacheDirectory(String[] pCacheDir)
                       throws IOException,
                              AutomationException

Gets the cache directory/location.

Product Availability

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

Parameters:

pCacheDir - The pCacheDir (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update(IImageServer pImageServer,
            IEnvelope pExtent,
            ILongArray pLevels,
            int updateMode,
            ITrackCancel pTrackCancel)
            throws IOException,
                   AutomationException

Updates cache within a given extent.

Product Availability

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

Parameters:

pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)

updateMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateByGeometry

void updateByGeometry(IImageServer pImageServer,
                      IGeometry pGeometry,
                      ILongArray pLevels,
                      int updateMode,
                      ITrackCancel pTrackCancel)
                      throws IOException,
                             AutomationException

Updates cache within an area of interest defined by a given geometry.

Product Availability

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

Parameters:

pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)

updateMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadCount

int getThreadCount()
                   throws IOException,
                          AutomationException

The number of Image Cooker instances for building tile cache.

Product Availability

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

Returns:

The pThreadCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThreadCount

void setThreadCount(int pThreadCount)
                    throws IOException,
                           AutomationException

The number of Image Cooker instances for building tile cache.

Product Availability

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

Parameters:

pThreadCount - The pThreadCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumImageCellsize

double getMaximumImageCellsize()
                               throws IOException,
                                      AutomationException

The maximum source image cellsize below which data are available.

Product Availability

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

Returns:

The pMaxPS

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumImageCellsize

void setMaximumImageCellsize(double pMaxPS)
                             throws IOException,
                                    AutomationException

The maximum source image cellsize below which data are available.

Product Availability

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

Parameters:

pMaxPS - The pMaxPS (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerObjectName

IName getServerObjectName()
                          throws IOException,
                                 AutomationException

The ArcGIS server object to run the image cooker.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerObjectNameByRef

void setServerObjectNameByRef(IName ppName)
                              throws IOException,
                                     AutomationException

The ArcGIS server object to run the image cooker.

Product Availability

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

Parameters:

ppName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.