com.esri.arcgis.datasourcesraster
Interface IFunctionRasterDataset

All Superinterfaces:

Serializable

All Known Subinterfaces:

IFunctionRasterDataset2

All Known Implementing Classes:

FunctionRasterDataset, IFunctionRasterDatasetProxy, MosaicDataset

public interface IFunctionRasterDataset
extends Serializable

Provides access to members that control a function raster dataset.

Product Availability

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

Method Summary

void	alterDefinition() Saves any changes made to this dataset.
void	findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID, IArray ppMatchingFunctionArguments) Finds raster function arguments in this dataset that match the given function arguments CLSID.
IArray	findMemberFunctionsByCLSID(IUID rasterFunctionCLSID) Finds raster functions in this dataset that match the given function CLSID.
IArray	findMemberFunctionsByName(String rasterFunctionName) Finds raster functions in this dataset that match the given function name.
Object	getArguments() The raster function arguments.
IRasterFunction	getFunction() The raster function.
IArray	getMemberDatasetNames() The constituent datasets names referenced by this function raster dataset.
IArray	getMemberRasterDatasets() The constituent raster datasets in this function raster dataset.
IPropertySet	getProperties() The function raster dataset proprties.
IRasterInfo	getRasterInfo() The raster information.
void	init(IRasterFunction pFunction, Object pArguments) Initializes this function raster dataset.
void	setArgumentsByRef(Object ppArguments) The raster function arguments.
void	setFullNameByRef(IName rhs1) The name of this function raster dataset.
void	setFunctionByRef(IRasterFunction ppFunction) The raster function.
void	setPropertiesByRef(IPropertySet ppProperties) The function raster dataset proprties.
void	simplify() Simplifies the function raster dataset by removing redundant raster functions.

Method Detail

setFullNameByRef

void setFullNameByRef(IName rhs1)
                      throws IOException,
                             AutomationException

The name of this function raster dataset.

Product Availability

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

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

void init(IRasterFunction pFunction,
          Object pArguments)
          throws IOException,
                 AutomationException

Initializes this function raster dataset.

Product Availability

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

Parameters:

pFunction - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunction

IRasterFunction getFunction()
                            throws IOException,
                                   AutomationException

The raster function.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFunctionByRef

void setFunctionByRef(IRasterFunction ppFunction)
                      throws IOException,
                             AutomationException

The raster function.

Product Availability

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

Parameters:

ppFunction - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArguments

Object getArguments()
                    throws IOException,
                           AutomationException

The raster function arguments.

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.

setArgumentsByRef

void setArgumentsByRef(Object ppArguments)
                       throws IOException,
                              AutomationException

The raster function arguments.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The function raster dataset proprties.

Product Availability

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

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.

setPropertiesByRef

void setPropertiesByRef(IPropertySet ppProperties)
                        throws IOException,
                               AutomationException

The function raster dataset proprties.

Product Availability

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

Parameters:

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

getRasterInfo

IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The raster information.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterDefinition

void alterDefinition()
                     throws IOException,
                            AutomationException

Saves any changes made to this dataset.

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.

getMemberRasterDatasets

IArray getMemberRasterDatasets()
                               throws IOException,
                                      AutomationException

The constituent raster datasets in this function raster dataset.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMemberDatasetNames

IArray getMemberDatasetNames()
                             throws IOException,
                                    AutomationException

The constituent datasets names referenced by this function raster dataset.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMemberFunctionsByCLSID

IArray findMemberFunctionsByCLSID(IUID rasterFunctionCLSID)
                                  throws IOException,
                                         AutomationException

Finds raster functions in this dataset that match the given function CLSID.

Product Availability

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

Parameters:

rasterFunctionCLSID - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMemberFunctionsByName

IArray findMemberFunctionsByName(String rasterFunctionName)
                                 throws IOException,
                                        AutomationException

Finds raster functions in this dataset that match the given function name.

Product Availability

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

Parameters:

rasterFunctionName - The rasterFunctionName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMemberFunctionsArgumentsByCLSID

void findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID,
                                         IArray ppMatchingFunctionArguments)
                                         throws IOException,
                                                AutomationException

Finds raster function arguments in this dataset that match the given function arguments CLSID.

Product Availability

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

Parameters:

functionArgumentsCLSID - A reference to a com.esri.arcgis.system.IUID (in)

ppMatchingFunctionArguments - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simplify

void simplify()
              throws IOException,
                     AutomationException

Simplifies the function raster dataset by removing redundant raster functions.

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.