com.esri.arcgis.datasourcesraster
Class RasterFunctionVariable

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

All Implemented Interfaces:

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

public class RasterFunctionVariable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionVariable, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

The class for template raster function arguments.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterFunctionVariable()
Constructs a RasterFunctionVariable using ArcGIS Engine.

RasterFunctionVariable(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterFunctionVariable theRasterFunctionVariable = (RasterFunctionVariable) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IStringArray	getAliases() The variable's aliases.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getDescription() The variable's description.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getName() The variable name.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
Object	getValue() The variable value.
int	hashCode() the hashcode for this object
boolean	isDataset() Indicates whether the variable is a dataset.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	resolve(Object pArgumentValues) Resolves the variable using a set of values.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAliasesByRef(IStringArray ppAliases) The variable's aliases.
void	setDescription(String pDescription) The variable's description.
void	setIsDataset(boolean pbIsDataset) Indicates whether the variable is a dataset.
void	setName(String pName) The variable name.
void	setValue(Object pValue) The variable value.
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

RasterFunctionVariable

public RasterFunctionVariable()
                       throws IOException,
                              UnknownHostException

Constructs a RasterFunctionVariable using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterFunctionVariable

public RasterFunctionVariable(Object obj)
                       throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getName

public String getName()
               throws IOException,
                      AutomationException

The variable name.

Product Availability

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

Specified by:

getName in interface IRasterFunctionVariable

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pName)
             throws IOException,
                    AutomationException

The variable name.

Product Availability

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

Specified by:

setName in interface IRasterFunctionVariable

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue()
                throws IOException,
                       AutomationException

The variable value.

Product Availability

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

Specified by:

getValue in interface IRasterFunctionVariable

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(Object pValue)
              throws IOException,
                     AutomationException

The variable value.

Product Availability

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

Specified by:

setValue in interface IRasterFunctionVariable

Parameters:

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(Object pArgumentValues)
             throws IOException,
                    AutomationException

Resolves the variable using a set of values.

Product Availability

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

Specified by:

resolve in interface IRasterFunctionVariable

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

The variable's description.

Product Availability

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

Specified by:

setDescription in interface IRasterFunctionVariable

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The variable's description.

Product Availability

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

Specified by:

getDescription in interface IRasterFunctionVariable

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasesByRef

public void setAliasesByRef(IStringArray ppAliases)
                     throws IOException,
                            AutomationException

The variable's aliases.

Product Availability

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

Specified by:

setAliasesByRef in interface IRasterFunctionVariable

Parameters:

ppAliases - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliases

public IStringArray getAliases()
                        throws IOException,
                               AutomationException

The variable's aliases.

Product Availability

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

Specified by:

getAliases in interface IRasterFunctionVariable

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.

setIsDataset

public void setIsDataset(boolean pbIsDataset)
                  throws IOException,
                         AutomationException

Indicates whether the variable is a dataset.

Product Availability

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

Specified by:

setIsDataset in interface IRasterFunctionVariable

Parameters:

pbIsDataset - The pbIsDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataset

public boolean isDataset()
                  throws IOException,
                         AutomationException

Indicates whether the variable is a dataset.

Product Availability

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

Specified by:

isDataset in interface IRasterFunctionVariable

Returns:

The pbIsDataset

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