com.esri.arcgis.datasourcesraster
Class StretchFunctionArguments

java.lang.Object
  com.esri.arcgis.datasourcesraster.StretchFunctionArguments

All Implemented Interfaces:

IRasterFunctionArguments, IStretchFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class StretchFunctionArguments
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IStretchFunctionArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

A class for stretch raster function arguments.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

StretchFunctionArguments()
Constructs a StretchFunctionArguments using ArcGIS Engine.

StretchFunctionArguments(Object obj)
Construct a StretchFunctionArguments using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IStringArray	getFileList() The list of all files associated with the arguments.
IDoubleArray	getGamma() The list of Gamma value(s).
IArray	getHistograms() The custom raster stretch histogram.
double	getMax() The current maximum output value.
double	getMaxPercent() The current maximum percent value.
double	getMin() The current minimum output value.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
double	getMinPercent() The current minimum percent value.
IStringArray	getNames() The list of all argument names.
double	getNumberOfStandardDeviations() The number of standard deviations for standard deviation stretch.
Object	getRaster() The source raster object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IArray	getStatistics() The custom raster stretch statistics.
int	getStretchType() The stretch type.
Object	getValue(String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isUseGamma() Indicates if applies Gamma stretch.
void	load(IStream pstm) load
void	putValue(String name, Object value) Puts a named argument value.
void	readExternal(ObjectInput in)
void	remove(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	setGammaByRef(IDoubleArray ppGamma) The list of Gamma value(s).
void	setHistogramsByRef(IArray ppHistograms) The custom raster stretch histogram.
void	setMax(double pMaxValue) The current maximum output value.
void	setMaxPercent(double pPercent) The current maximum percent value.
void	setMin(double pMinValue) The current minimum output value.
void	setMinPercent(double pPercent) The current minimum percent value.
void	setNumberOfStandardDeviations(double pNumStdDevs) The number of standard deviations for standard deviation stretch.
void	setRasterByRef(Object ppRaster) The source raster object.
void	setStatisticsByRef(IArray ppStats) The custom raster stretch statistics.
void	setStretchType(int pStretchType) The stretch type.
void	setUseGamma(boolean pUseGamma) Indicates if applies Gamma stretch.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

StretchFunctionArguments

public StretchFunctionArguments()
                         throws IOException,
                                UnknownHostException

Constructs a StretchFunctionArguments using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

StretchFunctionArguments

public StretchFunctionArguments(Object obj)
                         throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems StretchFunctionArguments theStretchFunctionArguments = (StretchFunctionArguments) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getValue

public Object getValue(String name)
                throws IOException,
                       AutomationException

Gets a named argument value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(String name,
                     Object value)
              throws IOException,
                     AutomationException

Puts a named argument value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(String name)
            throws IOException,
                   AutomationException

Removes a named argument value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all argument values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws IOException,
                             AutomationException

The list of all argument names.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws IOException,
                               AutomationException

The list of all arguments.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws IOException,
                                AutomationException

The list of all files associated with the arguments.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolve

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

Resolves function variables using a row and set of properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:

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 IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

public Object getRaster()
                 throws IOException,
                        AutomationException

The source raster object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getRaster in interface IStretchFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException

The source raster object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setRasterByRef in interface IStretchFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStretchType

public int getStretchType()
                   throws IOException,
                          AutomationException

The stretch type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getStretchType in interface IStretchFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterStretchType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStretchType

public void setStretchType(int pStretchType)
                    throws IOException,
                           AutomationException

The stretch type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setStretchType in interface IStretchFunctionArguments

Parameters:

pStretchType - A com.esri.arcgis.datasourcesraster.esriRasterStretchType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGamma

public IDoubleArray getGamma()
                      throws IOException,
                             AutomationException

The list of Gamma value(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getGamma in interface IStretchFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGammaByRef

public void setGammaByRef(IDoubleArray ppGamma)
                   throws IOException,
                          AutomationException

The list of Gamma value(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setGammaByRef in interface IStretchFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatistics

public IArray getStatistics()
                     throws IOException,
                            AutomationException

The custom raster stretch statistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getStatistics in interface IStretchFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatisticsByRef

public void setStatisticsByRef(IArray ppStats)
                        throws IOException,
                               AutomationException

The custom raster stretch statistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setStatisticsByRef in interface IStretchFunctionArguments

Parameters:

ppStats - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHistograms

public IArray getHistograms()
                     throws IOException,
                            AutomationException

The custom raster stretch histogram.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getHistograms in interface IStretchFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistogramsByRef

public void setHistogramsByRef(IArray ppHistograms)
                        throws IOException,
                               AutomationException

The custom raster stretch histogram.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setHistogramsByRef in interface IStretchFunctionArguments

Parameters:

ppHistograms - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberOfStandardDeviations

public void setNumberOfStandardDeviations(double pNumStdDevs)
                                   throws IOException,
                                          AutomationException

The number of standard deviations for standard deviation stretch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setNumberOfStandardDeviations in interface IStretchFunctionArguments

Parameters:

pNumStdDevs - The pNumStdDevs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberOfStandardDeviations

public double getNumberOfStandardDeviations()
                                     throws IOException,
                                            AutomationException

The number of standard deviations for standard deviation stretch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNumberOfStandardDeviations in interface IStretchFunctionArguments

Returns:

The pNumStdDevs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGamma

public boolean isUseGamma()
                   throws IOException,
                          AutomationException

Indicates if applies Gamma stretch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isUseGamma in interface IStretchFunctionArguments

Returns:

The pUseGamma

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGamma

public void setUseGamma(boolean pUseGamma)
                 throws IOException,
                        AutomationException

Indicates if applies Gamma stretch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUseGamma in interface IStretchFunctionArguments

Parameters:

pUseGamma - The pUseGamma (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMin

public double getMin()
              throws IOException,
                     AutomationException

The current minimum output value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMin in interface IStretchFunctionArguments

Returns:

The pMinValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMin

public void setMin(double pMinValue)
            throws IOException,
                   AutomationException

The current minimum output value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setMin in interface IStretchFunctionArguments

Parameters:

pMinValue - The pMinValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMax

public double getMax()
              throws IOException,
                     AutomationException

The current maximum output value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMax in interface IStretchFunctionArguments

Returns:

The pMaxValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMax

public void setMax(double pMaxValue)
            throws IOException,
                   AutomationException

The current maximum output value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setMax in interface IStretchFunctionArguments

Parameters:

pMaxValue - The pMaxValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinPercent

public double getMinPercent()
                     throws IOException,
                            AutomationException

The current minimum percent value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMinPercent in interface IStretchFunctionArguments

Returns:

The pPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinPercent

public void setMinPercent(double pPercent)
                   throws IOException,
                          AutomationException

The current minimum percent value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setMinPercent in interface IStretchFunctionArguments

Parameters:

pPercent - The pPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxPercent

public double getMaxPercent()
                     throws IOException,
                            AutomationException

The current maximum percent value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMaxPercent in interface IStretchFunctionArguments

Returns:

The pPercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxPercent

public void setMaxPercent(double pPercent)
                   throws IOException,
                          AutomationException

The current maximum percent value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setMaxPercent in interface IStretchFunctionArguments

Parameters:

pPercent - The pPercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException