com.esri.arcgis.datasourcesraster
Interface IRasterFunctionTemplate2

All Superinterfaces:

IRasterFunctionTemplate, Serializable

All Known Implementing Classes:

RasterFunctionTemplate

public interface IRasterFunctionTemplate2
extends IRasterFunctionTemplate, Serializable

Provides access to members that control a raster template function.

Product Availability

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

Method Summary

void	findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID, IArray ppMatchingFunctionArguments) Finds raster function arguments in this template that match the given function arguments CLSID.
IArray	findMemberFunctionsByCLSID(IUID rasterFunctionCLSID) Finds raster functions in this template that match the given function CLSID.
IArray	findMemberFunctionsByName(String rasterFunctionName) Finds raster functions in this template that match the given function name.
String	getHelp() The help document URL.
IPropertySet	getProperties() The properties.
void	setHelp(String pHelp) The help document URL.
void	setPropertiesByRef(IPropertySet pProperties) The properties.

Methods inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate

getArguments, getFunction, getVariables, setArgumentsByRef, setFunctionByRef

Method Detail

getHelp

String getHelp()
               throws IOException,
                      AutomationException

The help document URL.

Product Availability

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

Returns:

The pHelp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelp

void setHelp(String pHelp)
             throws IOException,
                    AutomationException

The help document URL.

Product Availability

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

Parameters:

pHelp - The pHelp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The properties.

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 pProperties)
                        throws IOException,
                               AutomationException

The properties.

Product Availability

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

Parameters:

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

findMemberFunctionsByCLSID

IArray findMemberFunctionsByCLSID(IUID rasterFunctionCLSID)
                                  throws IOException,
                                         AutomationException

Finds raster functions in this template 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 template 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 template 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.