com.esri.arcgis.datasourcesraster
Class SAIFunctionArguments

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.SAIFunctionArguments
All Implemented Interfaces:
IRasterFunctionArguments, ISAIFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

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

COM Class 'SAIFunctionArguments'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'The Slope-Aspect Index (SAI) 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
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.ISAIFunctionArguments
IID, IIDb1b58723_1fe1_4158_8afe_a77ec8ec8785, 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
SAIFunctionArguments()
          Constructs a SAIFunctionArguments using ArcGIS Engine.
SAIFunctionArguments(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SAIFunctionArguments theSAIFunctionArguments = (SAIFunctionArguments) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.Object getDEM()
          The input elevation model.
 IStringArray getFileList()
          The list of all files associated with the arguments.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 IStringArray getNames()
          The list of all argument names.
 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.
 double getZFactor()
          The Z scale factor that converts z value to the unit of x and y.
 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 a SAIFunctionArguments.
 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 setDEMByRef(java.lang.Object ppDEM)
          The input elevation model.
 void setZFactor(double pZfactor)
          The Z scale factor that converts z value to the unit of x and y.
 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

SAIFunctionArguments

public SAIFunctionArguments()
                     throws java.io.IOException,
                            java.net.UnknownHostException
Constructs a SAIFunctionArguments using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SAIFunctionArguments

public SAIFunctionArguments(java.lang.Object obj)
                     throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SAIFunctionArguments theSAIFunctionArguments = (SAIFunctionArguments) obj;

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

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()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SAIFunctionArguments.

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.

getDEM

public java.lang.Object getDEM()
                        throws java.io.IOException,
                               AutomationException
The input elevation model.

Specified by:
getDEM in interface ISAIFunctionArguments
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDEMByRef

public void setDEMByRef(java.lang.Object ppDEM)
                 throws java.io.IOException,
                        AutomationException
The input elevation model.

Specified by:
setDEMByRef in interface ISAIFunctionArguments
Parameters:
ppDEM - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZFactor

public double getZFactor()
                  throws java.io.IOException,
                         AutomationException
The Z scale factor that converts z value to the unit of x and y.

Specified by:
getZFactor in interface ISAIFunctionArguments
Returns:
The pZfactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setZFactor

public void setZFactor(double pZfactor)
                throws java.io.IOException,
                       AutomationException
The Z scale factor that converts z value to the unit of x and y.

Specified by:
setZFactor in interface ISAIFunctionArguments
Parameters:
pZfactor - The pZfactor (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