com.esri.arcgis.datasourcesraster
Class DefineOverviewsParameters

java.lang.Object
  com.esri.arcgis.datasourcesraster.DefineOverviewsParameters

All Implemented Interfaces:

IBuildBoundaryParameters, ICalculateCellSizeRangesParameters, IDefineOverviewsParameters, IMosaicDatasetOperationParameters, IOverviewImageParameters, IOverviewTileParameters, ISelectionParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DefineOverviewsParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IDefineOverviewsParameters, IOverviewTileParameters, IOverviewImageParameters, ISelectionParameters, IBuildBoundaryParameters, ICalculateCellSizeRangesParameters, IThreadedOperationParameters

An object that controls how new overview items are created in a mosaic dataset.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DefineOverviewsParameters()
Constructs a DefineOverviewsParameters using ArcGIS Engine.

DefineOverviewsParameters(Object obj)
Construct a DefineOverviewsParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
IGeometry	getAoiGeometry() The polygon within which overview tiles are created.
double	getBufferDistanceFactor() The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.
double	getCellSize() The cell size of the first level of overview tiles.
double	getCellSizeClusterTolerance() The factor controlling clustering of cell sizes values.
static String	getClsid() getClsid.
int	getInstanceID() The object ID of the raster type instance associated with a preview define overview operation.
int	getLevels() The number of levels of overview tiles created.
int	getMaximumSizeOfTopmostOverview() The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
double	getMaxOverviewFactor() The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.
double	getMaxRangeFactor() The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
IPoint	getOrigin() The origin of the grid containing overview tiles.
int	getOverviewFactor() The factor by which two neighboring overview levels differ.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
IQueryFilter	getQueryFilter() The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	getRecommendedNumThreads(int[] pRecommendedNumThreads) The number of parallel threads of execution recommended by the system.
int	getResamplingMethod() The sampling method used on the mosaic dataset while generating the overview raster dataset.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
ISelectionSet	getSelectionSet() The selection set that identifies the collection of catalog items on which to perform the associated operation.
String	getServerName() The host machine name where parts of the operation are remotely executed.
IRasterStorageDef	getStorageDef() The raster storage definition.
int	getTileCols() The recommended number of pixel columns in each overview tiles.
int	getTileRows() The recommended number of pixel rows in each overview tiles.
double	getWeedTolerance() The tolerance for weeding points.
IWorkspaceName	getWorkspaceName() The workspace name where overview raster datasets are generated and stored.
int	hashCode() the hashcode for this object
boolean	isAppendToExistingBoundary() Indicates whether the computed boundary geometry is merged with existing mosaic boundary.
boolean	isCalculateLevels() Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.
boolean	isCalculateMosaicCellSizes() Indicates whether mosaic dataset's maximum visible cell size is calculated.
boolean	isCalculateRasterMaxCellSizes() Indicates whether maximum visibility values are calculated for selected items.
boolean	isCalculateRasterMinCellSizes() Indicates whether minimum visibility values are calculated for selected items.
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isForceOverviewTiles() Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.
boolean	isPerformWeeding() Indicates whether the computed boundary geometry is run through a point-weeding routine.
boolean	isRefreshAllInstances() Indicates whether all existing overview instances are refreshed.
boolean	isRemoveSlivers() Indicates whether polygons designated as slivers are removed from the boundary geometry.
boolean	isUpdateBoundary() Indicates whether the mosaic dataset is updated with the computed boundary geometry.
boolean	isUpdateMissingValuesOnly() Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.
void	setAoiGeometryByRef(IGeometry ppAoiGeometry) The polygon within which overview tiles are created.
void	setAppendToExistingBoundary(boolean pbAppendToExistingBoundary) Indicates whether the computed boundary geometry is merged with existing mosaic boundary.
void	setBufferDistanceFactor(double pBufferDistanceFactor) The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.
void	setCalculateLevels(boolean pbCalculateLevels) Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.
void	setCalculateMosaicCellSizes(boolean pbDoMosaicCellSizeRanges) Indicates whether mosaic dataset's maximum visible cell size is calculated.
void	setCalculateRasterMaxCellSizes(boolean pbDoCalculateMax) Indicates whether maximum visibility values are calculated for selected items.
void	setCalculateRasterMinCellSizes(boolean pbDoCalculateMin) Indicates whether minimum visibility values are calculated for selected items.
void	setCellSize(double pCellsize) The cell size of the first level of overview tiles.
void	setCellSizeClusterTolerance(double pCellSizeClusterTolerance) The factor controlling clustering of cell sizes values.
void	setForceOverviewTiles(boolean pbForceOverviewTiles) Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.
void	setInstanceID(int pInstanceID) The object ID of the raster type instance associated with a preview define overview operation.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setLevels(int pLevels) The number of levels of overview tiles created.
void	setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview) The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
void	setMaxOverviewFactor(double pMaxOverviewFactor) The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.
void	setMaxRangeFactor(double pMaxRangeFactor) The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items.
void	setNumThreads(int pNumThreads) The number of parallel threads that execute parts of the associated operation.
void	setOriginByRef(IPoint ppOrigin) The origin of the grid containing overview tiles.
void	setOverviewFactor(int pOverviewFactor) The factor by which two neighboring overview levels differ.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setPerformWeeding(boolean pbPerformWeeding) Indicates whether the computed boundary geometry is run through a point-weeding routine.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setQueryFilterByRef(IQueryFilter ppQueryFilter) The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	setRefreshAllInstances(boolean pbRefreshAllInstances) Indicates whether all existing overview instances are refreshed.
void	setRemoveSlivers(boolean pbRemoveSlivers) Indicates whether polygons designated as slivers are removed from the boundary geometry.
void	setResamplingMethod(int pSamplingMethod) The sampling method used on the mosaic dataset while generating the overview raster dataset.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setSelectionSetByRef(ISelectionSet ppSelectionSet) The selection set that identifies the collection of catalog items on which to perform the associated operation.
void	setServerName(String pServerName) The host machine name where parts of the operation are remotely executed.
void	setStorageDefByRef(IRasterStorageDef ppStorageDef) The raster storage definition.
void	setTileCols(int pTileColPixels) The recommended number of pixel columns in each overview tiles.
void	setTileRows(int pTileRowPixels) The recommended number of pixel rows in each overview tiles.
void	setUpdateBoundary(boolean pbUpdateBoundary) Indicates whether the mosaic dataset is updated with the computed boundary geometry.
void	setUpdateMissingValuesOnly(boolean pbUpdateMissingValuesOnly) Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.
void	setWeedTolerance(double pWeedTolerance) The tolerance for weeding points.
void	setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName) The workspace name where overview raster datasets are generated and stored.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

DefineOverviewsParameters

public DefineOverviewsParameters()
                          throws IOException,
                                 UnknownHostException

Constructs a DefineOverviewsParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DefineOverviewsParameters

public DefineOverviewsParameters(Object obj)
                          throws IOException

Construct a DefineOverviewsParameters using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DefineOverviewsParameters.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems DefineOverviewsParameters theDefineOverviewsParameters = (DefineOverviewsParameters) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppAllParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppOperationResults - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForceOverviewTiles

public void setForceOverviewTiles(boolean pbForceOverviewTiles)
                           throws IOException,
                                  AutomationException

Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.

Product Availability

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

Specified by:

setForceOverviewTiles in interface IDefineOverviewsParameters

Parameters:

pbForceOverviewTiles - The pbForceOverviewTiles (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isForceOverviewTiles

public boolean isForceOverviewTiles()
                             throws IOException,
                                    AutomationException

Indicates whether overview tiles are generated irrespective of existing primary or overview items in the specified area.

Product Availability

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

Specified by:

isForceOverviewTiles in interface IDefineOverviewsParameters

Returns:

The pbForceOverviewTiles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInstanceID

public void setInstanceID(int pInstanceID)
                   throws IOException,
                          AutomationException

The object ID of the raster type instance associated with a preview define overview operation. Properties that control how overview tiles are created are read from the matching raster type instance. A value here also indicates that no new schema is created by ????&

Product Availability

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

Specified by:

setInstanceID in interface IDefineOverviewsParameters

Parameters:

pInstanceID - The pInstanceID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInstanceID

public int getInstanceID()
                  throws IOException,
                         AutomationException

The object ID of the raster type instance associated with a preview define overview operation. Properties that control how overview tiles are created are read from the matching raster type instance. A value here also indicates that no new schema is created by ????&

Product Availability

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

Specified by:

getInstanceID in interface IDefineOverviewsParameters

Returns:

The pInstanceID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshAllInstances

public void setRefreshAllInstances(boolean pbRefreshAllInstances)
                            throws IOException,
                                   AutomationException

Indicates whether all existing overview instances are refreshed. A TRUE value also indicates that no new schema of overview tiles is created by the IMosaicDatasetOperation.DefineOverviews method.

Product Availability

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

Specified by:

setRefreshAllInstances in interface IDefineOverviewsParameters

Parameters:

pbRefreshAllInstances - The pbRefreshAllInstances (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRefreshAllInstances

public boolean isRefreshAllInstances()
                              throws IOException,
                                     AutomationException

Indicates whether all existing overview instances are refreshed. A TRUE value also indicates that no new schema of overview tiles is created by the IMosaicDatasetOperation.DefineOverviews method.

Product Availability

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

Specified by:

isRefreshAllInstances in interface IDefineOverviewsParameters

Returns:

The pbRefreshAllInstances

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAoiGeometryByRef

public void setAoiGeometryByRef(IGeometry ppAoiGeometry)
                         throws IOException,
                                AutomationException

The polygon within which overview tiles are created.

Product Availability

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

Specified by:

setAoiGeometryByRef in interface IOverviewTileParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAoiGeometry

public IGeometry getAoiGeometry()
                         throws IOException,
                                AutomationException

The polygon within which overview tiles are created.

Product Availability

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

Specified by:

getAoiGeometry in interface IOverviewTileParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginByRef

public void setOriginByRef(IPoint ppOrigin)
                    throws IOException,
                           AutomationException

The origin of the grid containing overview tiles.

Product Availability

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

Specified by:

setOriginByRef in interface IOverviewTileParameters

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.

getOrigin

public IPoint getOrigin()
                 throws IOException,
                        AutomationException

The origin of the grid containing overview tiles.

Product Availability

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

Specified by:

getOrigin in interface IOverviewTileParameters

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.

setCellSize

public void setCellSize(double pCellsize)
                 throws IOException,
                        AutomationException

The cell size of the first level of overview tiles.

Product Availability

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

Specified by:

setCellSize in interface IOverviewTileParameters

Parameters:

pCellsize - The pCellsize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public double getCellSize()
                   throws IOException,
                          AutomationException

The cell size of the first level of overview tiles.

Product Availability

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

Specified by:

getCellSize in interface IOverviewTileParameters

Returns:

The pCellsize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileCols

public void setTileCols(int pTileColPixels)
                 throws IOException,
                        AutomationException

The recommended number of pixel columns in each overview tiles.

Product Availability

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

Specified by:

setTileCols in interface IOverviewTileParameters

Parameters:

pTileColPixels - The pTileColPixels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileCols

public int getTileCols()
                throws IOException,
                       AutomationException

The recommended number of pixel columns in each overview tiles.

Product Availability

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

Specified by:

getTileCols in interface IOverviewTileParameters

Returns:

The pTileColPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRows

public void setTileRows(int pTileRowPixels)
                 throws IOException,
                        AutomationException

The recommended number of pixel rows in each overview tiles.

Product Availability

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

Specified by:

setTileRows in interface IOverviewTileParameters

Parameters:

pTileRowPixels - The pTileRowPixels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRows

public int getTileRows()
                throws IOException,
                       AutomationException

The recommended number of pixel rows in each overview tiles.

Product Availability

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

Specified by:

getTileRows in interface IOverviewTileParameters

Returns:

The pTileRowPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevels

public void setLevels(int pLevels)
               throws IOException,
                      AutomationException

The number of levels of overview tiles created.

Product Availability

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

Specified by:

setLevels in interface IOverviewTileParameters

Parameters:

pLevels - The pLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevels

public int getLevels()
              throws IOException,
                     AutomationException

The number of levels of overview tiles created.

Product Availability

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

Specified by:

getLevels in interface IOverviewTileParameters

Returns:

The pLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverviewFactor

public void setOverviewFactor(int pOverviewFactor)
                       throws IOException,
                              AutomationException

The factor by which two neighboring overview levels differ.

Product Availability

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

Specified by:

setOverviewFactor in interface IOverviewTileParameters

Parameters:

pOverviewFactor - The pOverviewFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverviewFactor

public int getOverviewFactor()
                      throws IOException,
                             AutomationException

The factor by which two neighboring overview levels differ.

Product Availability

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

Specified by:

getOverviewFactor in interface IOverviewTileParameters

Returns:

The pOverviewFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumSizeOfTopmostOverview

public void setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview)
                                     throws IOException,
                                            AutomationException

The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews.

Product Availability

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

Specified by:

setMaximumSizeOfTopmostOverview in interface IOverviewTileParameters

Parameters:

pMaximumSizeOfTopmostOverview - The pMaximumSizeOfTopmostOverview (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumSizeOfTopmostOverview

public int getMaximumSizeOfTopmostOverview()
                                    throws IOException,
                                           AutomationException

The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews.

Product Availability

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

Specified by:

getMaximumSizeOfTopmostOverview in interface IOverviewTileParameters

Returns:

The pMaximumSizeOfTopmostOverview

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName)
                           throws IOException,
                                  AutomationException

The workspace name where overview raster datasets are generated and stored.

Product Availability

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

Specified by:

setWorkspaceNameByRef in interface IOverviewTileParameters

Parameters:

ppOverviewWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

The workspace name where overview raster datasets are generated and stored.

Product Availability

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

Specified by:

getWorkspaceName in interface IOverviewTileParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageDef

public IRasterStorageDef getStorageDef()
                                throws IOException,
                                       AutomationException

The raster storage definition.

Product Availability

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

Specified by:

getStorageDef in interface IOverviewImageParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageDefByRef

public void setStorageDefByRef(IRasterStorageDef ppStorageDef)
                        throws IOException,
                               AutomationException

The raster storage definition.

Product Availability

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

Specified by:

setStorageDefByRef in interface IOverviewImageParameters

Parameters:

ppStorageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResamplingMethod

public void setResamplingMethod(int pSamplingMethod)
                         throws IOException,
                                AutomationException

The sampling method used on the mosaic dataset while generating the overview raster dataset.

Product Availability

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

Specified by:

setResamplingMethod in interface IOverviewImageParameters

Parameters:

pSamplingMethod - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResamplingMethod

public int getResamplingMethod()
                        throws IOException,
                               AutomationException

The sampling method used on the mosaic dataset while generating the overview raster dataset.

Product Availability

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

Specified by:

getResamplingMethod in interface IOverviewImageParameters

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:

setSelectionSetByRef in interface ISelectionParameters

Parameters:

ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:

getSelectionSet in interface ISelectionParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws IOException,
                                AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

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

Specified by:

setQueryFilterByRef in interface ISelectionParameters

Parameters:

ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

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

Specified by:

getQueryFilter in interface ISelectionParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAppendToExistingBoundary

public void setAppendToExistingBoundary(boolean pbAppendToExistingBoundary)
                                 throws IOException,
                                        AutomationException

Indicates whether the computed boundary geometry is merged with existing mosaic boundary.

Product Availability

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

Specified by:

setAppendToExistingBoundary in interface IBuildBoundaryParameters

Parameters:

pbAppendToExistingBoundary - The pbAppendToExistingBoundary (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAppendToExistingBoundary

public boolean isAppendToExistingBoundary()
                                   throws IOException,
                                          AutomationException

Indicates whether the computed boundary geometry is merged with existing mosaic boundary.

Product Availability

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

Specified by:

isAppendToExistingBoundary in interface IBuildBoundaryParameters

Returns:

The pbAppendToExistingBoundary

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerformWeeding

public void setPerformWeeding(boolean pbPerformWeeding)
                       throws IOException,
                              AutomationException

Indicates whether the computed boundary geometry is run through a point-weeding routine.

Product Availability

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

Specified by:

setPerformWeeding in interface IBuildBoundaryParameters

Parameters:

pbPerformWeeding - The pbPerformWeeding (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerformWeeding

public boolean isPerformWeeding()
                         throws IOException,
                                AutomationException

Indicates whether the computed boundary geometry is run through a point-weeding routine.

Product Availability

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

Specified by:

isPerformWeeding in interface IBuildBoundaryParameters

Returns:

The pbPerformWeeding

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeedTolerance

public void setWeedTolerance(double pWeedTolerance)
                      throws IOException,
                             AutomationException

The tolerance for weeding points.

Product Availability

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

Specified by:

setWeedTolerance in interface IBuildBoundaryParameters

Parameters:

pWeedTolerance - The pWeedTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWeedTolerance

public double getWeedTolerance()
                        throws IOException,
                               AutomationException

The tolerance for weeding points.

Product Availability

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

Specified by:

getWeedTolerance in interface IBuildBoundaryParameters

Returns:

The pWeedTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferDistanceFactor

public void setBufferDistanceFactor(double pBufferDistanceFactor)
                             throws IOException,
                                    AutomationException

The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.

Product Availability

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

Specified by:

setBufferDistanceFactor in interface IBuildBoundaryParameters

Parameters:

pBufferDistanceFactor - The pBufferDistanceFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferDistanceFactor

public double getBufferDistanceFactor()
                               throws IOException,
                                      AutomationException

The buffer factor applied on each item footprint before it is merged with the cumulative boundary geometry.

Product Availability

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

Specified by:

getBufferDistanceFactor in interface IBuildBoundaryParameters

Returns:

The pBufferDistanceFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveSlivers

public void setRemoveSlivers(boolean pbRemoveSlivers)
                      throws IOException,
                             AutomationException

Indicates whether polygons designated as slivers are removed from the boundary geometry.

Product Availability

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

Specified by:

setRemoveSlivers in interface IBuildBoundaryParameters

Parameters:

pbRemoveSlivers - The pbRemoveSlivers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveSlivers

public boolean isRemoveSlivers()
                        throws IOException,
                               AutomationException

Indicates whether polygons designated as slivers are removed from the boundary geometry.

Product Availability

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

Specified by:

isRemoveSlivers in interface IBuildBoundaryParameters

Returns:

The pbRemoveSlivers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateBoundary

public void setUpdateBoundary(boolean pbUpdateBoundary)
                       throws IOException,
                              AutomationException

Indicates whether the mosaic dataset is updated with the computed boundary geometry.

Product Availability

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

Specified by:

setUpdateBoundary in interface IBuildBoundaryParameters

Parameters:

pbUpdateBoundary - The pbUpdateBoundary (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdateBoundary

public boolean isUpdateBoundary()
                         throws IOException,
                                AutomationException

Indicates whether the mosaic dataset is updated with the computed boundary geometry.

Product Availability

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

Specified by:

isUpdateBoundary in interface IBuildBoundaryParameters

Returns:

The pbUpdateBoundary

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalculateRasterMinCellSizes

public void setCalculateRasterMinCellSizes(boolean pbDoCalculateMin)
                                    throws IOException,
                                           AutomationException

Indicates whether minimum visibility values are calculated for selected items.

Product Availability

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

Specified by:

setCalculateRasterMinCellSizes in interface ICalculateCellSizeRangesParameters

Parameters:

pbDoCalculateMin - The pbDoCalculateMin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCalculateRasterMinCellSizes

public boolean isCalculateRasterMinCellSizes()
                                      throws IOException,
                                             AutomationException

Indicates whether minimum visibility values are calculated for selected items.

Product Availability

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

Specified by:

isCalculateRasterMinCellSizes in interface ICalculateCellSizeRangesParameters

Returns:

The pbDoCalculateMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalculateRasterMaxCellSizes

public void setCalculateRasterMaxCellSizes(boolean pbDoCalculateMax)
                                    throws IOException,
                                           AutomationException

Indicates whether maximum visibility values are calculated for selected items.

Product Availability

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

Specified by:

setCalculateRasterMaxCellSizes in interface ICalculateCellSizeRangesParameters

Parameters:

pbDoCalculateMax - The pbDoCalculateMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCalculateRasterMaxCellSizes

public boolean isCalculateRasterMaxCellSizes()
                                      throws IOException,
                                             AutomationException

Indicates whether maximum visibility values are calculated for selected items.

Product Availability

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

Specified by:

isCalculateRasterMaxCellSizes in interface ICalculateCellSizeRangesParameters

Returns:

The pbDoCalculateMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalculateMosaicCellSizes

public void setCalculateMosaicCellSizes(boolean pbDoMosaicCellSizeRanges)
                                 throws IOException,
                                        AutomationException

Indicates whether mosaic dataset's maximum visible cell size is calculated.

Product Availability

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

Specified by:

setCalculateMosaicCellSizes in interface ICalculateCellSizeRangesParameters

Parameters:

pbDoMosaicCellSizeRanges - The pbDoMosaicCellSizeRanges (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCalculateMosaicCellSizes

public boolean isCalculateMosaicCellSizes()
                                   throws IOException,
                                          AutomationException

Indicates whether mosaic dataset's maximum visible cell size is calculated.

Product Availability

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

Specified by:

isCalculateMosaicCellSizes in interface ICalculateCellSizeRangesParameters

Returns:

The pbDoMosaicCellSizeRanges

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalculateLevels

public void setCalculateLevels(boolean pbCalculateLevels)
                        throws IOException,
                               AutomationException

Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.

Product Availability

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

Specified by:

setCalculateLevels in interface ICalculateCellSizeRangesParameters

Parameters:

pbCalculateLevels - The pbCalculateLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCalculateLevels

public boolean isCalculateLevels()
                          throws IOException,
                                 AutomationException

Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.

Product Availability

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

Specified by:

isCalculateLevels in interface ICalculateCellSizeRangesParameters

Returns:

The pbCalculateLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRangeFactor

public void setMaxRangeFactor(double pMaxRangeFactor)
                       throws IOException,
                              AutomationException

The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items. The maximum pixel size values of such items are computed by multiplying the corresponding low????&

Product Availability

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

Specified by:

setMaxRangeFactor in interface ICalculateCellSizeRangesParameters

Parameters:

pMaxRangeFactor - The pMaxRangeFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRangeFactor

public double getMaxRangeFactor()
                         throws IOException,
                                AutomationException

The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items. The maximum pixel size values of such items are computed by multiplying the corresponding low????&

Product Availability

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

Specified by:

getMaxRangeFactor in interface ICalculateCellSizeRangesParameters

Returns:

The pMaxRangeFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxOverviewFactor

public void setMaxOverviewFactor(double pMaxOverviewFactor)
                          throws IOException,
                                 AutomationException

The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.

Product Availability

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

Specified by:

setMaxOverviewFactor in interface ICalculateCellSizeRangesParameters

Parameters:

pMaxOverviewFactor - The pMaxOverviewFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxOverviewFactor

public double getMaxOverviewFactor()
                            throws IOException,
                                   AutomationException

The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.

Product Availability

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

Specified by:

getMaxOverviewFactor in interface ICalculateCellSizeRangesParameters

Returns:

The pMaxOverviewFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSizeClusterTolerance

public void setCellSizeClusterTolerance(double pCellSizeClusterTolerance)
                                 throws IOException,
                                        AutomationException

The factor controlling clustering of cell sizes values. Two cell size values with a difference factor less than the value in this property are considered one.

Product Availability

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

Specified by:

setCellSizeClusterTolerance in interface ICalculateCellSizeRangesParameters

Parameters:

pCellSizeClusterTolerance - The pCellSizeClusterTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSizeClusterTolerance

public double getCellSizeClusterTolerance()
                                   throws IOException,
                                          AutomationException

The factor controlling clustering of cell sizes values. Two cell size values with a difference factor less than the value in this property are considered one.

Product Availability

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

Specified by:

getCellSizeClusterTolerance in interface ICalculateCellSizeRangesParameters

Returns:

The pCellSizeClusterTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateMissingValuesOnly

public void setUpdateMissingValuesOnly(boolean pbUpdateMissingValuesOnly)
                                throws IOException,
                                       AutomationException

Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

Product Availability

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

Specified by:

setUpdateMissingValuesOnly in interface ICalculateCellSizeRangesParameters

Parameters:

pbUpdateMissingValuesOnly - The pbUpdateMissingValuesOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdateMissingValuesOnly

public boolean isUpdateMissingValuesOnly()
                                  throws IOException,
                                         AutomationException

Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

Product Availability

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

Specified by:

isUpdateMissingValuesOnly in interface ICalculateCellSizeRangesParameters

Returns:

The pbUpdateMissingValuesOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(String pServerName)
                   throws IOException,
                          AutomationException

The host machine name where parts of the operation are remotely executed.

Product Availability

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

Specified by:

setServerName in interface IThreadedOperationParameters

Parameters:

pServerName - The pServerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException

The host machine name where parts of the operation are remotely executed.

Product Availability

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

Specified by:

getServerName in interface IThreadedOperationParameters

Returns:

The pServerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws IOException,
                          AutomationException

The number of parallel threads that execute parts of the associated operation.

Product Availability

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

Specified by:

setNumThreads in interface IThreadedOperationParameters

Parameters:

pNumThreads - The pNumThreads (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumThreads

public int getNumThreads()
                  throws IOException,
                         AutomationException

The number of parallel threads that execute parts of the associated operation.

Product Availability

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

Specified by:

getNumThreads in interface IThreadedOperationParameters

Returns:

The pNumThreads

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

public void getRecommendedNumThreads(int[] pRecommendedNumThreads)
                              throws IOException,
                                     AutomationException

The number of parallel threads of execution recommended by the system.

Product Availability

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

Specified by:

getRecommendedNumThreads in interface IThreadedOperationParameters

Parameters:

pRecommendedNumThreads - The pRecommendedNumThreads (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.