com.esri.arcgis.datasourcesraster
Interface IRasterFunction2

All Superinterfaces:

Serializable

All Known Implementing Classes:

CachedRasterFunction, GeometricFunction, LasDatasetToRasterFunction, LasToRasterFunction, RasterInfoFunction, TerrainToRasterFunction

public interface IRasterFunction2
extends Serializable

Provides access to members that control a raster function.

Product Availability

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

Method Summary

void	clearCache(Object pArguments) Clear the cache.
IGeometry	computeFootprint(int maximumVertices) Computes the footprint.
void	getFiles(IGeometry pGeometry, IStringArray ppFiles) Gets source files within a given clipping geometry.
int	getInvalidDatasetProperties() The properties to be invalidated when a function raster dataset is initialized.
void	getProcessingCost(double[] pProcessingCost) getProcessingCost
boolean	isActive() Indicates if the function is actively participating in the chain.
boolean	isCacheStale() Indicates if the raster cache is stale and needs to be refreshed.
void	refreshCache() Refresh raster cache.
void	setInvalidDatasetProperties(int pDatasetProperties) The properties to be invalidated when a function raster dataset is initialized.

Method Detail

computeFootprint

IGeometry computeFootprint(int maximumVertices)
                           throws IOException,
                                  AutomationException

Computes the footprint.

Product Availability

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

Parameters:

maximumVertices - The maximumVertices (in)

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.

refreshCache

void refreshCache()
                  throws IOException,
                         AutomationException

Refresh raster cache.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearCache

void clearCache(Object pArguments)
                throws IOException,
                       AutomationException

Clear the cache.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFiles

void getFiles(IGeometry pGeometry,
              IStringArray ppFiles)
              throws IOException,
                     AutomationException

Gets source files within a given clipping geometry.

Product Availability

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

Parameters:

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

ppFiles - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcessingCost

void getProcessingCost(double[] pProcessingCost)
                       throws IOException,
                              AutomationException

getProcessingCost

Product Availability

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

Parameters:

pProcessingCost - The pProcessingCost (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheStale

boolean isCacheStale()
                     throws IOException,
                            AutomationException

Indicates if the raster cache is stale and needs to be refreshed.

Product Availability

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

Returns:

The pIsStale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isActive

boolean isActive()
                 throws IOException,
                        AutomationException

Indicates if the function is actively participating in the chain.

Product Availability

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

Returns:

The pIsActive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidDatasetProperties

int getInvalidDatasetProperties()
                                throws IOException,
                                       AutomationException

The properties to be invalidated when a function raster dataset is initialized.

Product Availability

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

Returns:

The pDatasetProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInvalidDatasetProperties

void setInvalidDatasetProperties(int pDatasetProperties)
                                 throws IOException,
                                        AutomationException

The properties to be invalidated when a function raster dataset is initialized.

Product Availability

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

Parameters:

pDatasetProperties - The pDatasetProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.