com.esri.arcgis.arcglobe
Interface IGlobeDeployment

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeDeployment

public interface IGlobeDeployment
extends Serializable

Provides access to the Globe deployment.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to be deployed.
void	deploy() Perform the deployment operations.
void	getCacheOp(ILayer pLayer, int[] pOp) The operation to be performed with the cache of a layer.
void	getCacheOpByIndex(int iLayer, int[] pOp) The operation to be performed with the cache of a layer by index.
void	getCachePath(ILayer pLayer, String[] pPath, String[] foldername) The deployment cache for a layer.
void	getCachePathByIndex(int iLayer, String[] pPath, String[] foldername) The deployment cache path of a layer by index.
String	getDefaultCacheLocation() The default location for setting/copying the caches.
IGMxDocument	getDocument() The deployed document.
void	getLayer(int iLayer, ILayer[] ppLayer) Gets a layer by index.
int	getLayerCount() The number of layers to be deployed.
void	getLocalPath(String absPath, String[] locPath) The local path corresponding to the given absolute path.
int	getPathTableCount() The number of different cache paths accumulated.
String	getSaveDocumentName() The full name of the new document to be saved.
String	getSummary(boolean bEstimateSizes) The text summary describing the deployment configuration.
void	getTablePath(int index, String[] pAbsPath, String[] pLocPath) Get each of the absolute and local cache paths accumulated.
boolean	isSaveNewDocument() Indicates whether a new document will be saved as opposed to modifying the current one.
boolean	isUseLocalPaths() Indicates whether to use internal local paths for data caches, given by the path table.
void	putCacheOp(ILayer pLayer, int op) The operation to be performed with the cache.
void	putCachePath(ILayer pLayer, String path, String foldername) The deployment cache for a layer.
void	putTablePath(String absPath, String locPath) Set an entry in the path table.
void	removeAllLayers() Removes all layers from the deployment list.
void	removeLayer(ILayer pLayer) Removes a layer from the deployment list.
void	setDefaultCacheLocation(String pName) The default location for setting/copying the caches.
void	setDocument(IGMxDocument ppDoc) The deployed document.
void	setSaveDocumentName(String pName) The full name of the new document to be saved.
void	setSaveNewDocument(boolean pbSaveNew) Indicates whether a new document will be saved as opposed to modifying the current one.
void	setUseLocalPaths(boolean pbUse) Indicates whether to use internal local paths for data caches, given by the path table.

Method Detail

setDocument

void setDocument(IGMxDocument ppDoc)
                 throws IOException,
                        AutomationException

The deployed document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

ppDoc - A reference to a com.esri.arcgis.arcglobe.IGMxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocument

IGMxDocument getDocument()
                         throws IOException,
                                AutomationException

The deployed document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

A reference to a com.esri.arcgis.arcglobe.IGMxDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveNewDocument

void setSaveNewDocument(boolean pbSaveNew)
                        throws IOException,
                               AutomationException

Indicates whether a new document will be saved as opposed to modifying the current one.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pbSaveNew - The pbSaveNew (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveNewDocument

boolean isSaveNewDocument()
                          throws IOException,
                                 AutomationException

Indicates whether a new document will be saved as opposed to modifying the current one.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

The pbSaveNew

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveDocumentName

void setSaveDocumentName(String pName)
                         throws IOException,
                                AutomationException

The full name of the new document to be saved.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaveDocumentName

String getSaveDocumentName()
                           throws IOException,
                                  AutomationException

The full name of the new document to be saved.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCacheLocation

void setDefaultCacheLocation(String pName)
                             throws IOException,
                                    AutomationException

The default location for setting/copying the caches.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCacheLocation

String getDefaultCacheLocation()
                               throws IOException,
                                      AutomationException

The default location for setting/copying the caches.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer pLayer)
              throws IOException,
                     AutomationException

Adds a layer to be deployed.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeLayer

void removeLayer(ILayer pLayer)
                 throws IOException,
                        AutomationException

Removes a layer from the deployment list.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllLayers

void removeAllLayers()
                     throws IOException,
                            AutomationException

Removes all layers from the deployment list.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

int getLayerCount()
                  throws IOException,
                         AutomationException

The number of layers to be deployed.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

void getLayer(int iLayer,
              ILayer[] ppLayer)
              throws IOException,
                     AutomationException

Gets a layer by index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

iLayer - The iLayer (in)

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCachePath

void putCachePath(ILayer pLayer,
                  String path,
                  String foldername)
                  throws IOException,
                         AutomationException

The deployment cache for a layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

path - The path (in)

foldername - The foldername (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCachePath

void getCachePath(ILayer pLayer,
                  String[] pPath,
                  String[] foldername)
                  throws IOException,
                         AutomationException

The deployment cache for a layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCachePathByIndex

void getCachePathByIndex(int iLayer,
                         String[] pPath,
                         String[] foldername)
                         throws IOException,
                                AutomationException

The deployment cache path of a layer by index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

iLayer - The iLayer (in)

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCacheOp

void putCacheOp(ILayer pLayer,
                int op)
                throws IOException,
                       AutomationException

The operation to be performed with the cache.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

op - A com.esri.arcgis.arcglobe.esriGlobeDeployCacheOp constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOp

void getCacheOp(ILayer pLayer,
                int[] pOp)
                throws IOException,
                       AutomationException

The operation to be performed with the cache of a layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pOp - A com.esri.arcgis.arcglobe.esriGlobeDeployCacheOp constant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOpByIndex

void getCacheOpByIndex(int iLayer,
                       int[] pOp)
                       throws IOException,
                              AutomationException

The operation to be performed with the cache of a layer by index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

iLayer - The iLayer (in)

pOp - A com.esri.arcgis.arcglobe.esriGlobeDeployCacheOp constant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseLocalPaths

boolean isUseLocalPaths()
                        throws IOException,
                               AutomationException

Indicates whether to use internal local paths for data caches, given by the path table.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

The pbUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseLocalPaths

void setUseLocalPaths(boolean pbUse)
                      throws IOException,
                             AutomationException

Indicates whether to use internal local paths for data caches, given by the path table.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

pbUse - The pbUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathTableCount

int getPathTableCount()
                      throws IOException,
                             AutomationException

The number of different cache paths accumulated.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTablePath

void getTablePath(int index,
                  String[] pAbsPath,
                  String[] pLocPath)
                  throws IOException,
                         AutomationException

Get each of the absolute and local cache paths accumulated.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

index - The index (in)

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putTablePath

void putTablePath(String absPath,
                  String locPath)
                  throws IOException,
                         AutomationException

Set an entry in the path table.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

absPath - The absPath (in)

locPath - The locPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocalPath

void getLocalPath(String absPath,
                  String[] locPath)
                  throws IOException,
                         AutomationException

The local path corresponding to the given absolute path.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

absPath - The absPath (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSummary

String getSummary(boolean bEstimateSizes)
                  throws IOException,
                         AutomationException

The text summary describing the deployment configuration.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

bEstimateSizes - The bEstimateSizes (in)

Returns:

The pSummary

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deploy

void deploy()
            throws IOException,
                   AutomationException

Perform the deployment operations.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.