com.esri.arcgis.datasourcesraster
Interface IRasterFunctionVariable

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterFunctionVariable

public interface IRasterFunctionVariable
extends Serializable

Provides access to members that control a raster function variable.

Product Availability

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

Method Summary

IStringArray	getAliases() The variable's aliases.
String	getDescription() The variable's description.
String	getName() The variable name.
Object	getValue() The variable value.
boolean	isDataset() Indicates whether the variable is a dataset.
void	resolve(Object pArgumentValues) Resolves the variable using a set of values.
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.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The variable name.

Product Availability

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

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pName)
             throws IOException,
                    AutomationException

The variable name.

Product Availability

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

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue()
                throws IOException,
                       AutomationException

The variable value.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(Object pValue)
              throws IOException,
                     AutomationException

The variable value.

Product Availability

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

Parameters:

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolve

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.

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

void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

The variable's description.

Product Availability

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

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The variable's description.

Product Availability

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

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasesByRef

void setAliasesByRef(IStringArray ppAliases)
                     throws IOException,
                            AutomationException

The variable's aliases.

Product Availability

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

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

IStringArray getAliases()
                        throws IOException,
                               AutomationException

The variable's aliases.

Product Availability

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

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

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.

Parameters:

pbIsDataset - The pbIsDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataset

boolean isDataset()
                  throws IOException,
                         AutomationException

Indicates whether the variable is a dataset.

Product Availability

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

Returns:

The pbIsDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.