com.esri.arcgis.datasourcesraster

Class SpeckleFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.SpeckleFunctionArguments

All Implemented Interfaces:

IRasterFunctionArguments, ISpeckleFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class SpeckleFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, ISpeckleFunctionArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

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

Description 'A class for speckle raster function arguments.' 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.IRasterFunctionArguments

IID, IID04aa081e_28b0_47e4_b375_f367046da924, xxDummy

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

IID, IIDb8099ff7_e990_4418_ad03_efbd626875d7, xxDummy

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
SpeckleFunctionArguments() Constructs a SpeckleFunctionArguments using ArcGIS Engine.
SpeckleFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SpeckleFunctionArguments theSpeckleFunctionArguments = (SpeckleFunctionArguments) obj;

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
double	getAdditiveNoiseMean() The mean additive noise.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getDampFactor() The extent of damping applied.
IStringArray	getFileList() The list of all files associated with the arguments.
int	getFilterSize() The size of the speckle filter kernel.
int	getFilterType() The type of the speckle filter.
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).
double	getMultiplicativeNoiseMean() The mean multiplicative noise.
IStringArray	getNames() The list of all argument names.
int	getNLooks() The number of looks.
int	getNoiseModel() The speckle noise model.
double	getNoiseVariance() The noise variance.
java.lang.Object	getRaster() The source raster object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.Object	getValue(java.lang.String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	putValue(java.lang.String name, java.lang.Object value) Puts a named argument value.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(java.lang.String name) Removes a named argument value.
void	removeAll() Removes all argument values.
void	resolve(IRow pRow, IPropertySet pPropertySet) Resolves function variables using a row and set of properties.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAdditiveNoiseMean(double addNoiseMean) The mean additive noise.
void	setDampFactor(double dampFactor) The extent of damping applied.
void	setFilterSize(int pSize) The size of the speckle filter kernel.
void	setFilterType(int pType) The type of the speckle filter.
void	setMultiplicativeNoiseMean(double mulNoiseMean) The mean multiplicative noise.
void	setNLooks(int nLooks) The number of looks.
void	setNoiseModel(int type) The speckle noise model.
void	setNoiseVariance(double noiseVar) The noise variance.
void	setRasterByRef(java.lang.Object ppRaster) The source raster object.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
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

SpeckleFunctionArguments

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

Constructs a SpeckleFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SpeckleFunctionArguments

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

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

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

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

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Gets a named argument value.

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Puts a named argument value.

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Removes a named argument value.

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all argument values.

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws java.io.IOException,
                             AutomationException

The list of all argument names.

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws java.io.IOException,
                               AutomationException

The list of all arguments.

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws java.io.IOException,
                                AutomationException

The list of all files associated with the arguments.

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws java.io.IOException,
                    AutomationException

Resolves function variables using a row and set of properties.

Specified by:

resolve in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

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

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws java.io.IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Specified by:

update in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

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

pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRaster

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

The source raster object.

Specified by:

getRaster in interface ISpeckleFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(java.lang.Object ppRaster)
                    throws java.io.IOException,
                           AutomationException

The source raster object.

Specified by:

setRasterByRef in interface ISpeckleFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFilterType

public void setFilterType(int pType)
                   throws java.io.IOException,
                          AutomationException

The type of the speckle filter.

Specified by:

setFilterType in interface ISpeckleFunctionArguments

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriSpeckleFilterType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilterType

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

The type of the speckle filter.

Specified by:

getFilterType in interface ISpeckleFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriSpeckleFilterType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFilterSize

public void setFilterSize(int pSize)
                   throws java.io.IOException,
                          AutomationException

The size of the speckle filter kernel.

Specified by:

setFilterSize in interface ISpeckleFunctionArguments

Parameters:

pSize - A com.esri.arcgis.datasourcesraster.esriSpeckleFilterKernel constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilterSize

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

The size of the speckle filter kernel.

Specified by:

getFilterSize in interface ISpeckleFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriSpeckleFilterKernel constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoiseModel

public void setNoiseModel(int type)
                   throws java.io.IOException,
                          AutomationException

The speckle noise model. This parameter is used only for the Lee filter type.

Specified by:

setNoiseModel in interface ISpeckleFunctionArguments

Parameters:

type - A com.esri.arcgis.datasourcesraster.esriSpeckleNoiseModel constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoiseModel

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

The speckle noise model. This parameter is used only for the Lee filter type.

Specified by:

getNoiseModel in interface ISpeckleFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriSpeckleNoiseModel constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoiseVariance

public void setNoiseVariance(double noiseVar)
                      throws java.io.IOException,
                             AutomationException

The noise variance. This parameter is used only for Lee filter with Additive or Additive and Multiplicative(both) noise models.

Specified by:

setNoiseVariance in interface ISpeckleFunctionArguments

Parameters:

noiseVar - The noiseVar (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoiseVariance

public double getNoiseVariance()
                        throws java.io.IOException,
                               AutomationException

The noise variance. This parameter is used only for Lee filter with Additive or Additive and Multiplicative(both) noise models.

Specified by:

getNoiseVariance in interface ISpeckleFunctionArguments

Returns:

The noiseVar

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAdditiveNoiseMean

public void setAdditiveNoiseMean(double addNoiseMean)
                          throws java.io.IOException,
                                 AutomationException

The mean additive noise. This parameter is used only for Lee filter with Additive and Multiplicative(both) noise models.

Specified by:

setAdditiveNoiseMean in interface ISpeckleFunctionArguments

Parameters:

addNoiseMean - The addNoiseMean (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAdditiveNoiseMean

public double getAdditiveNoiseMean()
                            throws java.io.IOException,
                                   AutomationException

The mean additive noise. This parameter is used only for Lee filter with Additive and Multiplicative(both) noise models.

Specified by:

getAdditiveNoiseMean in interface ISpeckleFunctionArguments

Returns:

The addNoiseMean

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMultiplicativeNoiseMean

public void setMultiplicativeNoiseMean(double mulNoiseMean)
                                throws java.io.IOException,
                                       AutomationException

The mean multiplicative noise. This parameter is used only for Lee filter with Multiplicative or Additive and Multiplicative(both) noise models.

Specified by:

setMultiplicativeNoiseMean in interface ISpeckleFunctionArguments

Parameters:

mulNoiseMean - The mulNoiseMean (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMultiplicativeNoiseMean

public double getMultiplicativeNoiseMean()
                                  throws java.io.IOException,
                                         AutomationException

The mean multiplicative noise. This parameter is used only for Lee filter with Multiplicative or Additive and Multiplicative(both) noise models.

Specified by:

getMultiplicativeNoiseMean in interface ISpeckleFunctionArguments

Returns:

The mulNoiseMean

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNLooks

public void setNLooks(int nLooks)
               throws java.io.IOException,
                      AutomationException

The number of looks. This parameter is used only for Lee filter with Multiplicative noise model as well as the Enhanced Lee filter.

Specified by:

setNLooks in interface ISpeckleFunctionArguments

Parameters:

nLooks - The nLooks (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNLooks

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

The number of looks. This parameter is used only for Lee filter with Multiplicative noise model as well as the Enhanced Lee filter.

Specified by:

getNLooks in interface ISpeckleFunctionArguments

Returns:

The nLooks

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDampFactor

public void setDampFactor(double dampFactor)
                   throws java.io.IOException,
                          AutomationException

The extent of damping applied. This parameter is used only for Enhanced Lee filter and Frost filter.

Specified by:

setDampFactor in interface ISpeckleFunctionArguments

Parameters:

dampFactor - The dampFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDampFactor

public double getDampFactor()
                     throws java.io.IOException,
                            AutomationException

The extent of damping applied. This parameter is used only for Enhanced Lee filter and Frost filter.

Specified by:

getDampFactor in interface ISpeckleFunctionArguments

Returns:

The dampFactor

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