com.esri.arcgis.datasourcesraster

Interface ICachedRasterFunctionArguments

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CachedRasterFunctionArguments, ICachedRasterFunctionArgumentsProxy

public interface ICachedRasterFunctionArguments
extends java.io.Serializable

COM Interface 'ICachedRasterFunctionArguments'. Generated 9/21/2023 10:01:49 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control cached (item cache) function arguments.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID3ccf7e76_79c5_4f18_b2e3_4b5e25d89912
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
java.lang.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.
java.lang.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(java.lang.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(java.lang.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.

Field Detail

IID3ccf7e76_79c5_4f18_b2e3_4b5e25d89912

static final int IID3ccf7e76_79c5_4f18_b2e3_4b5e25d89912

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getRaster

java.lang.Object getRaster()
                    throws java.io.IOException,
                           AutomationException

The input raster.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(java.lang.Object ppRaster)
             throws java.io.IOException,
                    AutomationException

The input raster.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionType

void setCompressionType(int pType)
                 throws java.io.IOException,
                        AutomationException

The compression type.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionType

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

The compression type.

Returns:

A com.esri.arcgis.datasourcesraster.esriCachedRasterCompressionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

void setCompressionQuality(int value)
                    throws java.io.IOException,
                           AutomationException

The compression quality.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

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

The compression quality.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxAllowedInputCols

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

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

Returns:

The pCols

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxAllowedInputCols

void setMaxAllowedInputCols(int pCols)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

pCols - The pCols (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxAllowedInputRows

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

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

Returns:

The pRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxAllowedInputRows

void setMaxAllowedInputRows(int pRows)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

pRows - The pRows (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheBaseName

java.lang.String getCacheBaseName()
                           throws java.io.IOException,
                                  AutomationException

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

Returns:

The pCacheBaseName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheBaseName

void setCacheBaseName(java.lang.String pCacheBaseName)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

pCacheBaseName - The pCacheBaseName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClippingGeometry

IGeometry getClippingGeometry()
                       throws java.io.IOException,
                              AutomationException

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClippingGeometryByRef

void setClippingGeometryByRef(IGeometry ppClippingGeometry)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequestSize

double getRequestSize()
               throws java.io.IOException,
                      AutomationException

The request size used for resampling the item cache.

Returns:

The pRequestSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequestSize

void setRequestSize(double pRequestSize)
             throws java.io.IOException,
                    AutomationException

The request size used for resampling the item cache.

Parameters:

pRequestSize - The pRequestSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequestSizeType

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

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequestSizeType

void setRequestSizeType(int pRequestSizeType)
                 throws java.io.IOException,
                        AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.