com.esri.arcgis.datasourcesraster
Interface ICachedRasterFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

CachedRasterFunctionArguments

public interface ICachedRasterFunctionArguments
extends Serializable

Provides access to members that control Band Arithmetic function arguments.

Product Availability

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

Method Summary

String	getCacheBaseName() Name used for generating the CacheFileName.
IGeometry	getClippingGeometry() The clipping geometry that defines regions of valid pixels.
int	getCompressionQuality() The compression quality.
int	getCompressionType() The compression type.
int	getMaxAllowedInputCols() The maximum number of cols allowed in the input raster for generating the cache.
int	getMaxAllowedInputRows() The maximum number of rows allowed in the input raster for generating the cache.
Object	getRaster() The input raster.
double	getRequestSize() The request size used for resampling the item cache.
int	getRequestSizeType() The unit of the request size is determined by request size type.
void	setCacheBaseName(String pCacheBaseName) Name used for generating the CacheFileName.
void	setClippingGeometryByRef(IGeometry ppClippingGeometry) The clipping geometry that defines regions of valid pixels.
void	setCompressionQuality(int value) The compression quality.
void	setCompressionType(int pType) The compression type.
void	setMaxAllowedInputCols(int pCols) The maximum number of cols allowed in the input raster for generating the cache.
void	setMaxAllowedInputRows(int pRows) The maximum number of rows allowed in the input raster for generating the cache.
void	setRasterByRef(Object ppRaster) The input raster.
void	setRequestSize(double pRequestSize) The request size used for resampling the item cache.
void	setRequestSizeType(int pRequestSizeType) The unit of the request size is determined by request size type.

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException

The input raster.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException

The input raster.

Product Availability

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

Parameters:

ppRaster - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionType

void setCompressionType(int pType)
                        throws IOException,
                               AutomationException

The compression type.

Product Availability

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

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriCachedRasterCompressionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

int getCompressionType()
                       throws IOException,
                              AutomationException

The compression type.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriCachedRasterCompressionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

void setCompressionQuality(int value)
                           throws IOException,
                                  AutomationException

The compression quality.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

int getCompressionQuality()
                          throws IOException,
                                 AutomationException

The compression quality.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxAllowedInputCols

int getMaxAllowedInputCols()
                           throws IOException,
                                  AutomationException

The maximum number of cols allowed in the input raster for generating the cache.

Product Availability

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

Returns:

The pCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxAllowedInputCols

void setMaxAllowedInputCols(int pCols)
                            throws IOException,
                                   AutomationException

The maximum number of cols allowed in the input raster for generating the cache.

Product Availability

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

Parameters:

pCols - The pCols (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxAllowedInputRows

int getMaxAllowedInputRows()
                           throws IOException,
                                  AutomationException

The maximum number of rows allowed in the input raster for generating the cache.

Product Availability

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

Returns:

The pRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxAllowedInputRows

void setMaxAllowedInputRows(int pRows)
                            throws IOException,
                                   AutomationException

The maximum number of rows allowed in the input raster for generating the cache.

Product Availability

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

Parameters:

pRows - The pRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheBaseName

String getCacheBaseName()
                        throws IOException,
                               AutomationException

Name used for generating the CacheFileName. GUID is used if this is not specified.

Product Availability

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

Returns:

The pCacheBaseName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheBaseName

void setCacheBaseName(String pCacheBaseName)
                      throws IOException,
                             AutomationException

Name used for generating the CacheFileName. GUID is used if this is not specified.

Product Availability

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

Parameters:

pCacheBaseName - The pCacheBaseName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClippingGeometry

IGeometry getClippingGeometry()
                              throws IOException,
                                     AutomationException

The clipping geometry that defines regions of valid pixels. This geometry may have a coordinate system different from the corresponding dataset.

Product Availability

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

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.

setClippingGeometryByRef

void setClippingGeometryByRef(IGeometry ppClippingGeometry)
                              throws IOException,
                                     AutomationException

The clipping geometry that defines regions of valid pixels. This geometry may have a coordinate system different from the corresponding dataset.

Product Availability

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

Parameters:

ppClippingGeometry - 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.

getRequestSize

double getRequestSize()
                      throws IOException,
                             AutomationException

The request size used for resampling the item cache.

Product Availability

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

Returns:

The pRequestSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestSize

void setRequestSize(double pRequestSize)
                    throws IOException,
                           AutomationException

The request size used for resampling the item cache.

Product Availability

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

Parameters:

pRequestSize - The pRequestSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequestSizeType

int getRequestSizeType()
                       throws IOException,
                              AutomationException

The unit of the request size is determined by request size type.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestSizeType

void setRequestSizeType(int pRequestSizeType)
                        throws IOException,
                               AutomationException

The unit of the request size is determined by request size type.

Product Availability

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

Parameters:

pRequestSizeType - A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.