com.esri.arcgis.datasourcesraster

Class RasterFunctionTemplate

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterFunctionTemplate

All Implemented Interfaces:

IRasterFunction, IRasterFunctionTemplate, IRasterFunctionTemplate2, IRasterFunctionTemplate3, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class RasterFunctionTemplate
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunction, IRasterFunctionTemplate, IRasterFunctionTemplate2, IRasterFunctionTemplate3, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'RasterFunctionTemplate'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for a template raster function.' 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 =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunction

IID, IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate3

IID, IIDa4d65f9b_2ace_4089_941d_eb9ade49a29b, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate2

IIDe312d8af_1b60_482b_ae13_b8e111cfc894

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

IIDc395d08b_7fc8_4a61_ac3f_c114d690be52

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
RasterFunctionTemplate() Constructs a RasterFunctionTemplate using ArcGIS Engine.
RasterFunctionTemplate(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterFunctionTemplate theRasterFunctionTemplate = (RasterFunctionTemplate) obj;

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.Object pArguments) Binds function arguments to this raster function.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
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(java.lang.String rasterFunctionName) Finds raster functions in this template that match the given function name.
void	fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper) Loads raster function template from JSON.
java.lang.Object	getArguments() The raster function arguments in the template.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() The raster function description.
IRasterFunction	getFunction() The raster function in the template.
java.lang.String	getHelp() The help document URL.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.String	getName() The raster function name.
int	getPixelType() The output pixel type.
IPropertySet	getProperties() The properties.
IRasterInfo	getRasterInfo() The raster information after this function is applied to an object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IArray	getVariables() The raster function variables in the template.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isValid() Indicates if this function is valid, e.g.
void	load(IStream pstm) load
void	read(IPnt pTlc, IRaster pRaster, IPixelBlock pPixelBlock) Reads a pixel block starting from the top left corner.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setArgumentsByRef(java.lang.Object ppArgumets) The raster function arguments in the template.
void	setDescription(java.lang.String pDescription) The raster function description.
void	setFunctionByRef(IRasterFunction ppFunction) The raster function in the template.
void	setHelp(java.lang.String pHelp) The help document URL.
void	setName(java.lang.String pName) The raster function name.
void	setPixelType(int pPixelType) The output pixel type.
void	setPropertiesByRef(IPropertySet pProperties) The properties.
IJSONObject	toJSON() Saves raster function template to JSON.
void	update() Updates using newly available information from bound object.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RasterFunctionTemplate

public RasterFunctionTemplate()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a RasterFunctionTemplate using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterFunctionTemplate

public RasterFunctionTemplate(java.lang.Object obj)
                       throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterFunctionTemplate theRasterFunctionTemplate = (RasterFunctionTemplate) obj;

Construct a RasterFunctionTemplate using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterFunctionTemplate.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The raster function name.

Specified by:

getName in interface IRasterFunction

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException

The raster function name.

Specified by:

setName in interface IRasterFunction

Parameters:

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The raster function description.

Specified by:

getDescription in interface IRasterFunction

Returns:

The pDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pDescription)
                    throws java.io.IOException,
                           AutomationException

The raster function description.

Specified by:

setDescription in interface IRasterFunction

Parameters:

pDescription - The pDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws java.io.IOException,
                        AutomationException

The output pixel type.

Specified by:

getPixelType in interface IRasterFunction

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws java.io.IOException,
                         AutomationException

The output pixel type.

Specified by:

setPixelType in interface IRasterFunction

Parameters:

pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

bind

public void bind(java.lang.Object pArguments)
          throws java.io.IOException,
                 AutomationException

Binds function arguments to this raster function.

Specified by:

bind in interface IRasterFunction

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if this function is valid, e.g. bound to an object, and etc.

Specified by:

isValid in interface IRasterFunction

Returns:

The pValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws java.io.IOException,
                   AutomationException

Updates using newly available information from bound object.

Specified by:

update in interface IRasterFunction

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException

The raster information after this function is applied to an object.

Specified by:

getRasterInfo in interface IRasterFunction

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

read

public void read(IPnt pTlc,
                 IRaster pRaster,
                 IPixelBlock pPixelBlock)
          throws java.io.IOException,
                 AutomationException

Reads a pixel block starting from the top left corner.

Specified by:

read in interface IRasterFunction

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFunction

public IRasterFunction getFunction()
                            throws java.io.IOException,
                                   AutomationException

The raster function in the template.

Specified by:

getFunction in interface IRasterFunctionTemplate

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFunctionByRef

public void setFunctionByRef(IRasterFunction ppFunction)
                      throws java.io.IOException,
                             AutomationException

The raster function in the template.

Specified by:

setFunctionByRef in interface IRasterFunctionTemplate

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setArgumentsByRef

public void setArgumentsByRef(java.lang.Object ppArgumets)
                       throws java.io.IOException,
                              AutomationException

The raster function arguments in the template.

Specified by:

setArgumentsByRef in interface IRasterFunctionTemplate

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArguments

public java.lang.Object getArguments()
                              throws java.io.IOException,
                                     AutomationException

The raster function arguments in the template.

Specified by:

getArguments in interface IRasterFunctionTemplate

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVariables

public IArray getVariables()
                    throws java.io.IOException,
                           AutomationException

The raster function variables in the template.

Specified by:

getVariables in interface IRasterFunctionTemplate

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelp

public java.lang.String getHelp()
                         throws java.io.IOException,
                                AutomationException

The help document URL.

Specified by:

getHelp in interface IRasterFunctionTemplate2

Returns:

The pHelp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelp

public void setHelp(java.lang.String pHelp)
             throws java.io.IOException,
                    AutomationException

The help document URL.

Specified by:

setHelp in interface IRasterFunctionTemplate2

Parameters:

pHelp - The pHelp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

The properties.

Specified by:

getProperties in interface IRasterFunctionTemplate2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet pProperties)
                        throws java.io.IOException,
                               AutomationException

The properties.

Specified by:

setPropertiesByRef in interface IRasterFunctionTemplate2

Parameters:

pProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findMemberFunctionsByCLSID

public IArray findMemberFunctionsByCLSID(IUID rasterFunctionCLSID)
                                  throws java.io.IOException,
                                         AutomationException

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

Specified by:

findMemberFunctionsByCLSID in interface IRasterFunctionTemplate2

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findMemberFunctionsByName

public IArray findMemberFunctionsByName(java.lang.String rasterFunctionName)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

findMemberFunctionsByName in interface IRasterFunctionTemplate2

Parameters:

rasterFunctionName - The rasterFunctionName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findMemberFunctionsArgumentsByCLSID

public void findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID,
                                                IArray ppMatchingFunctionArguments)
                                         throws java.io.IOException,
                                                AutomationException

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

Specified by:

findMemberFunctionsArgumentsByCLSID in interface IRasterFunctionTemplate2

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toJSON

public IJSONObject toJSON()
                   throws java.io.IOException,
                          AutomationException

Saves raster function template to JSON.

Specified by:

toJSON in interface IRasterFunctionTemplate3

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromJSON

public void fromJSON(IJSONObject pJSON,
                     IRasterFunctionTemplateMapper pOptRFTMapper)
              throws java.io.IOException,
                     AutomationException

Loads raster function template from JSON.

Specified by:

fromJSON in interface IRasterFunctionTemplate3

Parameters:

pJSON - A reference to a com.esri.arcgis.system.IJSONObject (in)

pOptRFTMapper - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException