com.esri.arcgis.globecore
Interface IGlobeServerCooker

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GlobeServerCooker, IGlobeServerCookerProxy

public interface IGlobeServerCooker
extends java.io.Serializable

COM Interface 'IGlobeServerCooker'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description: 'Provides access to members for Generating Tiles with Globe server object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDa5e12264_b2d2_4e6c_af14_ea09f870b3bb
static int	xxDummy Deprecated. Internal use only

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(java.lang.String[] pLayerName, int[] pLayerID, double[] pProgressPercent) Gets the current Cooker object cooking progress.
void	getThreadHandle(int[] pHandle) Gets the Cook thread handle.
void	initCooking(java.lang.String serverName, java.lang.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.

Field Detail

IIDa5e12264_b2d2_4e6c_af14_ea09f870b3bb

static final int IIDa5e12264_b2d2_4e6c_af14_ea09f870b3bb

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getMinLOD

int getMinLOD()
              throws java.io.IOException,
                     AutomationException

The minimum Level Of detail for cooking.

Returns:

The pMinLOD

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinLOD

void setMinLOD(int pMinLOD)
               throws java.io.IOException,
                      AutomationException

The minimum Level Of detail for cooking.

Parameters:

pMinLOD - The pMinLOD (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxLOD

int getMaxLOD()
              throws java.io.IOException,
                     AutomationException

The maximum Level Of detail for cooking.

Returns:

The pMaxLOD

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxLOD

void setMaxLOD(int pMaxLOD)
               throws java.io.IOException,
                      AutomationException

The maximum Level Of detail for cooking.

Parameters:

pMaxLOD - The pMaxLOD (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAOI

IEnvelope getAOI()
                 throws java.io.IOException,
                        AutomationException

The area of interest for cooking in GCS.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputLyrId

void setInputLyrId(int rhs1)
                   throws java.io.IOException,
                          AutomationException

The layer id of the layer to be cooked.

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAOI

void setAOI(IEnvelope ppExtent)
            throws java.io.IOException,
                   AutomationException

The area of interest for cooking in GCS.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initCooking

void initCooking(java.lang.String serverName,
                 java.lang.String serverObjectName)
                 throws java.io.IOException,
                        AutomationException

cooks a given globe server object on a given server.

Parameters:

serverName - The serverName (in)

serverObjectName - The serverObjectName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

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

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

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTiles

void removeTiles(IEnvelope pExtent)
                 throws java.io.IOException,
                        AutomationException

Removes tiles from within the specified extent.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws java.io.IOException,
                   AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStats

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

Gets the current Cooker object cooking progress.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadHandle

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

Gets the Cook thread handle.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastError

void getLastError()
                  throws java.io.IOException,
                         AutomationException

Gets the last error.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.