com.esri.arcgis.datasourcesraster

Class NDVIFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.NDVIFunctionArguments

All Implemented Interfaces:

INDVIFunctionArguments, INDVIFunctionArguments2, INDVIFunctionArguments3, IRasterFunctionArguments, IRasterFunctionArguments2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class NDVIFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IRasterFunctionArguments2, INDVIFunctionArguments, INDVIFunctionArguments2, INDVIFunctionArguments3, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'NDVIFunctionArguments'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for NDVI 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.IRasterFunctionArguments2

IID, IIDfd4f0d2d_1f81_4b2d_8ae5_90cef59c3cfe, xxDummy

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

IID04aa081e_28b0_47e4_b375_f367046da924

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

IID, IIDfdaf4a17_ac0a_4cc7_9e95_ee022fc0d928, xxDummy

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

IID191462d1_d3f7_460c_9508_a5e1268e3d5f

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

IIDb8c15ba4_ed8c_4e85_9166_f4f149cc3170

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
NDVIFunctionArguments() Constructs a NDVIFunctionArguments using ArcGIS Engine.
NDVIFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. NDVIFunctionArguments theNDVIFunctionArguments = (NDVIFunctionArguments) 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
void	fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper) Loads raster function arguments from JSON.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IStringArray	getFileList() The list of all files associated with the arguments.
int	getInfraredBandID() The infrared band id.
java.lang.String	getInfraredBandName() Infrared band name.
double	getInfraredBandWavelength() Infrared band wavelength.
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).
int	getMissingBandAction() Indicates how the raster function behaves when a request band (specified by index, name, or wavelength) is not found in the input raster.
IStringArray	getNames() The list of all argument names.
java.lang.Object	getRaster() The input raster.
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	getVisibleBandID() The visible band id.
java.lang.String	getVisibleBandName() Visible band name.
double	getVisibleBandWavelength() Visible band wavelength.
double	getWavelengthMatchTolerance() The wavelength tolerance value in nanometers.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isScientificOutput() Indicates the output values should be between -1 and 1.
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	setInfraredBandID(int pInfraredBandID) The infrared band id.
void	setInfraredBandName(java.lang.String pInfraredBandName) Infrared band name.
void	setInfraredBandWavelength(double pInfraredBandWavelength) Infrared band wavelength.
void	setMissingBandAction(int pMissingBandAction) Indicates how the raster function behaves when a request band (specified by index, name, or wavelength) is not found in the input raster.
void	setRasterByRef(java.lang.Object ppRaster) The input raster.
void	setScientificOutput(boolean pbScientific) Indicates the output values should be between -1 and 1.
void	setVisibleBandID(int pVisibleBandID) The visible band id.
void	setVisibleBandName(java.lang.String pVisibleBandName) Visible band name.
void	setVisibleBandWavelength(double pVisibleBandWavelength) Visible band wavelength.
void	setWavelengthMatchTolerance(double pWavelengthMatchTolerance) The wavelength tolerance value in nanometers.
IJSONObject	toJSON() Saves raster function arguments to JSON.
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

NDVIFunctionArguments

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

Constructs a NDVIFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NDVIFunctionArguments

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

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

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

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.

toJSON

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

Saves raster function arguments to JSON.

Specified by:

toJSON in interface IRasterFunctionArguments2

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 arguments from JSON.

Specified by:

fromJSON in interface IRasterFunctionArguments2

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.

getRaster

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

The input raster.

Specified by:

getRaster in interface INDVIFunctionArguments

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 input raster.

Specified by:

setRasterByRef in interface INDVIFunctionArguments

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.

getVisibleBandID

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

The visible band id.

Specified by:

getVisibleBandID in interface INDVIFunctionArguments

Returns:

The pVisibleBandID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisibleBandID

public void setVisibleBandID(int pVisibleBandID)
                      throws java.io.IOException,
                             AutomationException

The visible band id.

Specified by:

setVisibleBandID in interface INDVIFunctionArguments

Parameters:

pVisibleBandID - The pVisibleBandID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInfraredBandID

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

The infrared band id.

Specified by:

getInfraredBandID in interface INDVIFunctionArguments

Returns:

The pInfraredBandID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInfraredBandID

public void setInfraredBandID(int pInfraredBandID)
                       throws java.io.IOException,
                              AutomationException

The infrared band id.

Specified by:

setInfraredBandID in interface INDVIFunctionArguments

Parameters:

pInfraredBandID - The pInfraredBandID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMissingBandAction

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

Indicates how the raster function behaves when a request band (specified by index, name, or wavelength) is not found in the input raster.

Specified by:

getMissingBandAction in interface INDVIFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMissingBandAction

public void setMissingBandAction(int pMissingBandAction)
                          throws java.io.IOException,
                                 AutomationException

Indicates how the raster function behaves when a request band (specified by index, name, or wavelength) is not found in the input raster.

Specified by:

setMissingBandAction in interface INDVIFunctionArguments2

Parameters:

pMissingBandAction - A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWavelengthMatchTolerance

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

The wavelength tolerance value in nanometers. For a raster band to be associated with a requested wavelength, the two wavelengths must lie within this tolerance.

Specified by:

getWavelengthMatchTolerance in interface INDVIFunctionArguments2

Returns:

The pWavelengthMatchTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWavelengthMatchTolerance

public void setWavelengthMatchTolerance(double pWavelengthMatchTolerance)
                                 throws java.io.IOException,
                                        AutomationException

The wavelength tolerance value in nanometers. For a raster band to be associated with a requested wavelength, the two wavelengths must lie within this tolerance.

Specified by:

setWavelengthMatchTolerance in interface INDVIFunctionArguments2

Parameters:

pWavelengthMatchTolerance - The pWavelengthMatchTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVisibleBandName

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

Visible band name.

Specified by:

getVisibleBandName in interface INDVIFunctionArguments2

Returns:

The pVisibleBandName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisibleBandName

public void setVisibleBandName(java.lang.String pVisibleBandName)
                        throws java.io.IOException,
                               AutomationException

Visible band name.

Specified by:

setVisibleBandName in interface INDVIFunctionArguments2

Parameters:

pVisibleBandName - The pVisibleBandName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInfraredBandName

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

Infrared band name.

Specified by:

getInfraredBandName in interface INDVIFunctionArguments2

Returns:

The pInfraredBandName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInfraredBandName

public void setInfraredBandName(java.lang.String pInfraredBandName)
                         throws java.io.IOException,
                                AutomationException

Infrared band name.

Specified by:

setInfraredBandName in interface INDVIFunctionArguments2

Parameters:

pInfraredBandName - The pInfraredBandName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVisibleBandWavelength

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

Visible band wavelength.

Specified by:

getVisibleBandWavelength in interface INDVIFunctionArguments2

Returns:

The pVisibleBandWavelength

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisibleBandWavelength

public void setVisibleBandWavelength(double pVisibleBandWavelength)
                              throws java.io.IOException,
                                     AutomationException

Visible band wavelength.

Specified by:

setVisibleBandWavelength in interface INDVIFunctionArguments2

Parameters:

pVisibleBandWavelength - The pVisibleBandWavelength (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInfraredBandWavelength

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

Infrared band wavelength.

Specified by:

getInfraredBandWavelength in interface INDVIFunctionArguments2

Returns:

The pInfraredBandWavelength

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInfraredBandWavelength

public void setInfraredBandWavelength(double pInfraredBandWavelength)
                               throws java.io.IOException,
                                      AutomationException

Infrared band wavelength.

Specified by:

setInfraredBandWavelength in interface INDVIFunctionArguments2

Parameters:

pInfraredBandWavelength - The pInfraredBandWavelength (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScientificOutput

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

Indicates the output values should be between -1 and 1.

Specified by:

isScientificOutput in interface INDVIFunctionArguments3

Returns:

The pbScientific

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScientificOutput

public void setScientificOutput(boolean pbScientific)
                         throws java.io.IOException,
                                AutomationException

Indicates the output values should be between -1 and 1.

Specified by:

setScientificOutput in interface INDVIFunctionArguments3

Parameters:

pbScientific - The pbScientific (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