com.esri.arcgis.datasourcesraster

Class TrendFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.TrendFunctionArguments

All Implemented Interfaces:

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

public class TrendFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IRasterFunctionArguments2, ITrendFunctionArguments, ITrendFunctionArguments2, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

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

Description 'The Trend 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.ITrendFunctionArguments2

IID, IID534cfe4b_c42c_4282_9ffb_61a84a1d2705, xxDummy

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

IID1b183727_8275_436c_9227_baeef6e04bfb

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
TrendFunctionArguments() Constructs a TrendFunctionArguments using ArcGIS Engine.
TrendFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TrendFunctionArguments theTrendFunctionArguments = (TrendFunctionArguments) 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.
IDoubleArray	getCurveParameters() The simple curve trend surface parameters.
int	getDimensionDefinitionType() The input dimension definition type.
java.lang.String	getDimensionEnd() The prediction dimensional end value.
double	getDimensionInterval() The prediction dimensional interval.
java.lang.String	getDimensionStart() The prediction dimensional start value.
java.lang.String	getDimensionUnit() The input dimension definition type.
java.lang.String	getDimensionValues() The prediction dimensional value.
IStringArray	getFileList() The list of all files associated with the arguments.
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).
IStringArray	getNames() The list of all argument names.
IDoubleArray	getPlaneParameters() The plane trend surface parameters.
java.lang.Object	getRaster() The input raster for conversion.
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	setCurveParametersByRef(IDoubleArray ppParameters) The simple curve trend surface parameters.
void	setDimensionDefinitionType(int pDimensionDefinition) The input dimension definition type.
void	setDimensionEnd(java.lang.String pDimEnd) The prediction dimensional end value.
void	setDimensionInterval(double pDimInterval) The prediction dimensional interval.
void	setDimensionStart(java.lang.String pDimStart) The prediction dimensional start value.
void	setDimensionUnit(java.lang.String pDimensionUnit) The input dimension definition type.
void	setDimensionValues(java.lang.String pDimValue) The prediction dimensional value.
void	setPlaneParametersByRef(IDoubleArray ppParameters) The plane trend surface parameters.
void	setRasterByRef(java.lang.Object ppRaster) The input raster for conversion.
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

TrendFunctionArguments

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

Constructs a TrendFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TrendFunctionArguments

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

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

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

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 for conversion.

Specified by:

getRaster in interface ITrendFunctionArguments

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 for conversion.

Specified by:

setRasterByRef in interface ITrendFunctionArguments

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.

getPlaneParameters

public IDoubleArray getPlaneParameters()
                                throws java.io.IOException,
                                       AutomationException

The plane trend surface parameters.

Specified by:

getPlaneParameters in interface ITrendFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPlaneParametersByRef

public void setPlaneParametersByRef(IDoubleArray ppParameters)
                             throws java.io.IOException,
                                    AutomationException

The plane trend surface parameters.

Specified by:

setPlaneParametersByRef in interface ITrendFunctionArguments

Parameters:

ppParameters - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurveParameters

public IDoubleArray getCurveParameters()
                                throws java.io.IOException,
                                       AutomationException

The simple curve trend surface parameters.

Specified by:

getCurveParameters in interface ITrendFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurveParametersByRef

public void setCurveParametersByRef(IDoubleArray ppParameters)
                             throws java.io.IOException,
                                    AutomationException

The simple curve trend surface parameters.

Specified by:

setCurveParametersByRef in interface ITrendFunctionArguments

Parameters:

ppParameters - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionValues

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

The prediction dimensional value.

Specified by:

getDimensionValues in interface ITrendFunctionArguments2

Returns:

The pDimValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDimensionValues

public void setDimensionValues(java.lang.String pDimValue)
                        throws java.io.IOException,
                               AutomationException

The prediction dimensional value.

Specified by:

setDimensionValues in interface ITrendFunctionArguments2

Parameters:

pDimValue - The pDimValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionDefinitionType

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

The input dimension definition type.

Specified by:

getDimensionDefinitionType in interface ITrendFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterDimensionDefinitionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDimensionDefinitionType

public void setDimensionDefinitionType(int pDimensionDefinition)
                                throws java.io.IOException,
                                       AutomationException

The input dimension definition type.

Specified by:

setDimensionDefinitionType in interface ITrendFunctionArguments2

Parameters:

pDimensionDefinition - A com.esri.arcgis.datasourcesraster.esriRasterDimensionDefinitionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionStart

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

The prediction dimensional start value.

Specified by:

getDimensionStart in interface ITrendFunctionArguments2

Returns:

The pDimStart

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDimensionStart

public void setDimensionStart(java.lang.String pDimStart)
                       throws java.io.IOException,
                              AutomationException

The prediction dimensional start value.

Specified by:

setDimensionStart in interface ITrendFunctionArguments2

Parameters:

pDimStart - The pDimStart (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionEnd

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

The prediction dimensional end value.

Specified by:

getDimensionEnd in interface ITrendFunctionArguments2

Returns:

The pDimEnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDimensionEnd

public void setDimensionEnd(java.lang.String pDimEnd)
                     throws java.io.IOException,
                            AutomationException

The prediction dimensional end value.

Specified by:

setDimensionEnd in interface ITrendFunctionArguments2

Parameters:

pDimEnd - The pDimEnd (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionInterval

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

The prediction dimensional interval.

Specified by:

getDimensionInterval in interface ITrendFunctionArguments2

Returns:

The pDimInterval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDimensionInterval

public void setDimensionInterval(double pDimInterval)
                          throws java.io.IOException,
                                 AutomationException

The prediction dimensional interval.

Specified by:

setDimensionInterval in interface ITrendFunctionArguments2

Parameters:

pDimInterval - The pDimInterval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDimensionUnit

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

The input dimension definition type.

Specified by:

getDimensionUnit in interface ITrendFunctionArguments2

Returns:

The pDimensionUnit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDimensionUnit

public void setDimensionUnit(java.lang.String pDimensionUnit)
                      throws java.io.IOException,
                             AutomationException

The input dimension definition type.

Specified by:

setDimensionUnit in interface ITrendFunctionArguments2

Parameters:

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