com.esri.arcgis.datasourcesraster
Class CalculateCellSizeRangesParameters

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

All Implemented Interfaces:

ICalculateCellSizeRangesParameters, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CalculateCellSizeRangesParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, ICalculateCellSizeRangesParameters, ISelectionParameters

An object that controls how visibility ranges for items in a mosaic dataset are computed.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CalculateCellSizeRangesParameters()
Constructs a CalculateCellSizeRangesParameters using ArcGIS Engine.

CalculateCellSizeRangesParameters(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CalculateCellSizeRangesParameters theCalculateCellSizeRangesParameters = (CalculateCellSizeRangesParameters) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
double	getCellSizeClusterTolerance() The factor controlling clustering of cell sizes values.
static String	getClsid() getClsid.
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.
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.
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.
int	hashCode() the hashcode for this object
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	isUpdateMissingValuesOnly() Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.
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	setCellSizeClusterTolerance(double pCellSizeClusterTolerance) The factor controlling clustering of cell sizes values.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
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	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
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	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	setUpdateMissingValuesOnly(boolean pbUpdateMissingValuesOnly) Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

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

CalculateCellSizeRangesParameters

public CalculateCellSizeRangesParameters()
                                  throws IOException,
                                         UnknownHostException

Constructs a CalculateCellSizeRangesParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CalculateCellSizeRangesParameters

public CalculateCellSizeRangesParameters(Object obj)
                                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CalculateCellSizeRangesParameters theCalculateCellSizeRangesParameters = (CalculateCellSizeRangesParameters) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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.

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.

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.