com.esri.arcgis.datasourcesraster
Class ExcludedAreaFunctionArguments

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

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

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

Description 'The arguments for the ExcludedArea raster function.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

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.IExcludedAreaFunctionArguments
IID, IIDdfff1d7c_bee4_4bf3_8781_f6092817fa98, 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
ExcludedAreaFunctionArguments()
          Constructs a ExcludedAreaFunctionArguments using ArcGIS Engine.
ExcludedAreaFunctionArguments(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExcludedAreaFunctionArguments theExcludedAreaFunctionArguments = (ExcludedAreaFunctionArguments) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(java.lang.Object o)
          Compare this object with another
 double getBlackThreshold()
          The black threshold value.
 double getBlueThreshold()
          The blue threshold value.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 double getCyanThreshold()
          The cyan threshold value.
 IStringArray getFileList()
          The list of all files associated with the arguments.
 double getGreenThreshold()
          The green threshold value.
 double getHighHistogramThreshold()
          The high histogram threshold value.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 double getLowHistogramThreshold()
          The low histogram threshold value.
 double getMagitaThreshold()
          The magita threshold value.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 IStringArray getNames()
          The list of all argument names.
 int getPixelBitDepth()
          The actual pixel bit depth.
 java.lang.Object getRaster()
          The input raster.
 double getRedThreshold()
          The red threshold value.
 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 getWhiteThreshold()
          The white threshold value.
 double getYellowThreshold()
          The yellow threshold value.
 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 ExcludedAreaFunctionArguments.
 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 setBlackThreshold(double pValue)
          The black threshold value.
 void setBlueThreshold(double pValue)
          The blue threshold value.
 void setCyanThreshold(double pValue)
          The cyan threshold value.
 void setGreenThreshold(double pValue)
          The green threshold value.
 void setHighHistogramThreshold(double pValue)
          The high histogram threshold value.
 void setLowHistogramThreshold(double pValue)
          The low histogram threshold value.
 void setMagitaThreshold(double pValue)
          The magita threshold value.
 void setPixelBitDepth(int pValue)
          The actual pixel bit depth.
 void setRasterByRef(java.lang.Object ppRaster)
          The input raster.
 void setRedThreshold(double pValue)
          The red threshold value.
 void setWhiteThreshold(double pValue)
          The white threshold value.
 void setYellowThreshold(double pValue)
          The yellow threshold value.
 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

ExcludedAreaFunctionArguments

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

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

ExcludedAreaFunctionArguments

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

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

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

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

Specified by:
getRaster in interface IExcludedAreaFunctionArguments
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 IExcludedAreaFunctionArguments
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.

getWhiteThreshold

public double getWhiteThreshold()
                         throws java.io.IOException,
                                AutomationException
The white threshold value.

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

setWhiteThreshold

public void setWhiteThreshold(double pValue)
                       throws java.io.IOException,
                              AutomationException
The white threshold value.

Specified by:
setWhiteThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlackThreshold

public double getBlackThreshold()
                         throws java.io.IOException,
                                AutomationException
The black threshold value.

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

setBlackThreshold

public void setBlackThreshold(double pValue)
                       throws java.io.IOException,
                              AutomationException
The black threshold value.

Specified by:
setBlackThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRedThreshold

public double getRedThreshold()
                       throws java.io.IOException,
                              AutomationException
The red threshold value.

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

setRedThreshold

public void setRedThreshold(double pValue)
                     throws java.io.IOException,
                            AutomationException
The red threshold value.

Specified by:
setRedThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGreenThreshold

public double getGreenThreshold()
                         throws java.io.IOException,
                                AutomationException
The green threshold value.

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

setGreenThreshold

public void setGreenThreshold(double pValue)
                       throws java.io.IOException,
                              AutomationException
The green threshold value.

Specified by:
setGreenThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlueThreshold

public double getBlueThreshold()
                        throws java.io.IOException,
                               AutomationException
The blue threshold value.

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

setBlueThreshold

public void setBlueThreshold(double pValue)
                      throws java.io.IOException,
                             AutomationException
The blue threshold value.

Specified by:
setBlueThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCyanThreshold

public double getCyanThreshold()
                        throws java.io.IOException,
                               AutomationException
The cyan threshold value.

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

setCyanThreshold

public void setCyanThreshold(double pValue)
                      throws java.io.IOException,
                             AutomationException
The cyan threshold value.

Specified by:
setCyanThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMagitaThreshold

public double getMagitaThreshold()
                          throws java.io.IOException,
                                 AutomationException
The magita threshold value.

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

setMagitaThreshold

public void setMagitaThreshold(double pValue)
                        throws java.io.IOException,
                               AutomationException
The magita threshold value.

Specified by:
setMagitaThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getYellowThreshold

public double getYellowThreshold()
                          throws java.io.IOException,
                                 AutomationException
The yellow threshold value.

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

setYellowThreshold

public void setYellowThreshold(double pValue)
                        throws java.io.IOException,
                               AutomationException
The yellow threshold value.

Specified by:
setYellowThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLowHistogramThreshold

public double getLowHistogramThreshold()
                                throws java.io.IOException,
                                       AutomationException
The low histogram threshold value.

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

setLowHistogramThreshold

public void setLowHistogramThreshold(double pValue)
                              throws java.io.IOException,
                                     AutomationException
The low histogram threshold value.

Specified by:
setLowHistogramThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHighHistogramThreshold

public double getHighHistogramThreshold()
                                 throws java.io.IOException,
                                        AutomationException
The high histogram threshold value.

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

setHighHistogramThreshold

public void setHighHistogramThreshold(double pValue)
                               throws java.io.IOException,
                                      AutomationException
The high histogram threshold value.

Specified by:
setHighHistogramThreshold in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelBitDepth

public int getPixelBitDepth()
                     throws java.io.IOException,
                            AutomationException
The actual pixel bit depth.

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

setPixelBitDepth

public void setPixelBitDepth(int pValue)
                      throws java.io.IOException,
                             AutomationException
The actual pixel bit depth.

Specified by:
setPixelBitDepth in interface IExcludedAreaFunctionArguments
Parameters:
pValue - The pValue (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