com.esri.arcgis.globecore
Interface IGlobeServerCooker

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeServerCooker

public interface IGlobeServerCooker
extends Serializable

Provides access to members for Generating Tiles with Globe server object.

Product Availability

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

Method Summary

void	cancel() Cancels cooking.
IEnvelope	getAOI() The area of interest for cooking in GCS.
void	getLastError() Gets the last error.
int	getMaxLOD() The maximum Level Of detail for cooking.
int	getMinLOD() The minimum Level Of detail for cooking.
void	getStats(String[] pLayerName, int[] pLayerID, double[] pProgressPercent) Gets the current Cooker object cooking progress.
void	getThreadHandle(int[] pHandle) Gets the Cook thread handle.
void	initCooking(String serverName, String serverObjectName) cooks a given globe server object on a given server.
void	removeTiles(IEnvelope pExtent) Removes tiles from within the specified extent.
void	setAOI(IEnvelope ppExtent) The area of interest for cooking in GCS.
void	setInputLyrId(int rhs1) The layer id of the layer to be cooked.
void	setMaxLOD(int pMaxLOD) The maximum Level Of detail for cooking.
void	setMinLOD(int pMinLOD) The minimum Level Of detail for cooking.
void	update(IEnvelope pExtent, int pUpdatemode) Sets the extent of the region to be updated and the caching mode.

Method Detail

getMinLOD

int getMinLOD()
              throws IOException,
                     AutomationException

The minimum Level Of detail for cooking.

Product Availability

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

Returns:

The pMinLOD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinLOD

void setMinLOD(int pMinLOD)
               throws IOException,
                      AutomationException

The minimum Level Of detail for cooking.

Product Availability

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

Parameters:

pMinLOD - The pMinLOD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxLOD

int getMaxLOD()
              throws IOException,
                     AutomationException

The maximum Level Of detail for cooking.

Product Availability

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

Returns:

The pMaxLOD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxLOD

void setMaxLOD(int pMaxLOD)
               throws IOException,
                      AutomationException

The maximum Level Of detail for cooking.

Product Availability

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

Parameters:

pMaxLOD - The pMaxLOD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAOI

IEnvelope getAOI()
                 throws IOException,
                        AutomationException

The area of interest for cooking in GCS.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputLyrId

void setInputLyrId(int rhs1)
                   throws IOException,
                          AutomationException

The layer id of the layer to be cooked.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAOI

void setAOI(IEnvelope ppExtent)
            throws IOException,
                   AutomationException

The area of interest for cooking in GCS.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initCooking

void initCooking(String serverName,
                 String serverObjectName)
                 throws IOException,
                        AutomationException

cooks a given globe server object on a given server.

Product Availability

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

Parameters:

serverName - The serverName (in)

serverObjectName - The serverObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update(IEnvelope pExtent,
            int pUpdatemode)
            throws IOException,
                   AutomationException

Sets the extent of the region to be updated and the caching mode.

Product Availability

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

Parameters:

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

pUpdatemode - A com.esri.arcgis.globecore.esriGlobeCacheUpdateMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTiles

void removeTiles(IEnvelope pExtent)
                 throws IOException,
                        AutomationException

Removes tiles from within the specified extent.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Cancels cooking. It will additionally stop the cookers on the Server

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.

getStats

void getStats(String[] pLayerName,
              int[] pLayerID,
              double[] pProgressPercent)
              throws IOException,
                     AutomationException

Gets the current Cooker object cooking progress.

Product Availability

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

Parameters:

pLayerName - The pLayerName (in/out: use single element array)

pLayerID - The pLayerID (in/out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadHandle

void getThreadHandle(int[] pHandle)
                     throws IOException,
                            AutomationException

Gets the Cook thread handle.

Product Availability

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

Parameters:

pHandle - The pHandle (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastError

void getLastError()
                  throws IOException,
                         AutomationException

Gets the last error.

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.