public class RasterFunctionTemplate extends java.lang.Object implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunction, IRasterFunctionTemplate, IRasterFunctionTemplate2, IRasterFunctionTemplate3, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable
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 =
Modifier and Type | Field and Description |
---|---|
static long |
serialVersionUID |
IID, IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e, xxDummy
IID, IIDa4d65f9b_2ace_4089_941d_eb9ade49a29b, xxDummy
IIDe312d8af_1b60_482b_ae13_b8e111cfc894
IIDc395d08b_7fc8_4a61_ac3f_c114d690be52
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
IID0000010c_0000_0000_c000_000000000046
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
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; |
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) |
public static final long serialVersionUID
public RasterFunctionTemplate() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problemsjava.net.UnknownHostException
- if there are interop problemspublic RasterFunctionTemplate(java.lang.Object obj) throws java.io.IOException
RasterFunctionTemplate theRasterFunctionTemplate = (RasterFunctionTemplate) obj;
obj
to RasterFunctionTemplate
.obj
- an object returned from ArcGIS Engine or Serverjava.io.IOException
- if there are interop problemspublic static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface IRasterFunction
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setName(java.lang.String pName) throws java.io.IOException, AutomationException
setName
in interface IRasterFunction
pName
- The pName (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDescription() throws java.io.IOException, AutomationException
getDescription
in interface IRasterFunction
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setDescription(java.lang.String pDescription) throws java.io.IOException, AutomationException
setDescription
in interface IRasterFunction
pDescription
- The pDescription (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public int getPixelType() throws java.io.IOException, AutomationException
getPixelType
in interface IRasterFunction
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setPixelType(int pPixelType) throws java.io.IOException, AutomationException
setPixelType
in interface IRasterFunction
pPixelType
- A com.esri.arcgis.geodatabase.rstPixelType constant (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void bind(java.lang.Object pArguments) throws java.io.IOException, AutomationException
bind
in interface IRasterFunction
pArguments
- A reference to another Object (IUnknown) (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws java.io.IOException, AutomationException
isValid
in interface IRasterFunction
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void update() throws java.io.IOException, AutomationException
update
in interface IRasterFunction
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRasterInfo getRasterInfo() throws java.io.IOException, AutomationException
getRasterInfo
in interface IRasterFunction
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void read(IPnt pTlc, IRaster pRaster, IPixelBlock pPixelBlock) throws java.io.IOException, AutomationException
read
in interface IRasterFunction
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)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRasterFunction getFunction() throws java.io.IOException, AutomationException
getFunction
in interface IRasterFunctionTemplate
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setFunctionByRef(IRasterFunction ppFunction) throws java.io.IOException, AutomationException
setFunctionByRef
in interface IRasterFunctionTemplate
ppFunction
- A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setArgumentsByRef(java.lang.Object ppArgumets) throws java.io.IOException, AutomationException
setArgumentsByRef
in interface IRasterFunctionTemplate
ppArgumets
- A reference to another Object (IUnknown) (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getArguments() throws java.io.IOException, AutomationException
getArguments
in interface IRasterFunctionTemplate
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IArray getVariables() throws java.io.IOException, AutomationException
getVariables
in interface IRasterFunctionTemplate
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getHelp() throws java.io.IOException, AutomationException
getHelp
in interface IRasterFunctionTemplate2
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setHelp(java.lang.String pHelp) throws java.io.IOException, AutomationException
setHelp
in interface IRasterFunctionTemplate2
pHelp
- The pHelp (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IPropertySet getProperties() throws java.io.IOException, AutomationException
getProperties
in interface IRasterFunctionTemplate2
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setPropertiesByRef(IPropertySet pProperties) throws java.io.IOException, AutomationException
setPropertiesByRef
in interface IRasterFunctionTemplate2
pProperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IArray findMemberFunctionsByCLSID(IUID rasterFunctionCLSID) throws java.io.IOException, AutomationException
findMemberFunctionsByCLSID
in interface IRasterFunctionTemplate2
rasterFunctionCLSID
- A reference to a com.esri.arcgis.system.IUID (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IArray findMemberFunctionsByName(java.lang.String rasterFunctionName) throws java.io.IOException, AutomationException
findMemberFunctionsByName
in interface IRasterFunctionTemplate2
rasterFunctionName
- The rasterFunctionName (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void findMemberFunctionsArgumentsByCLSID(IUID functionArgumentsCLSID, IArray ppMatchingFunctionArguments) throws java.io.IOException, AutomationException
findMemberFunctionsArgumentsByCLSID
in interface IRasterFunctionTemplate2
functionArgumentsCLSID
- A reference to a com.esri.arcgis.system.IUID (in)ppMatchingFunctionArguments
- A reference to a com.esri.arcgis.system.IArray (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IJSONObject toJSON() throws java.io.IOException, AutomationException
toJSON
in interface IRasterFunctionTemplate3
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper) throws java.io.IOException, AutomationException
fromJSON
in interface IRasterFunctionTemplate3
pJSON
- A reference to a com.esri.arcgis.system.IJSONObject (in)pOptRFTMapper
- A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getMinNamespaceSupported() throws java.io.IOException, AutomationException
getMinNamespaceSupported
in interface IXMLVersionSupport
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException