com.esri.arcgis.datasourcesraster
Interface IRasterFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArithmeticFunctionArguments, ClipFunctionArguments, ColormapFunctionArguments, ColorspaceConversionFunctionArguments, ConstantFunctionArguments, ConvolutionFunctionArguments, ExcludedAreaFunctionArguments, ExtractBandFunctionArguments, FootprintFunctionArguments, GeometricFunctionArguments, GrayscaleFunctionArguments, HillshadeFunctionArguments, IRasterFunctionArgumentsProxy, MaskFunctionArguments, MLClassifyFunctionArguments, MosaicFunctionArguments, MosaicRastersFunctionArguments, NDVIFunctionArguments, PansharpeningFunctionArguments, RasterFunctionTemplateArguments, RasterInfoFunctionArguments, RemapFunctionArguments, SAIFunctionArguments, ShadedReliefFunctionArguments, SlopeFunctionArguments, SpectralConversionFunctionArguments, StatisticsFunctionArguments, StretchFunctionArguments, TrendFunctionArguments

public interface IRasterFunctionArguments
extends Serializable

Provides access to members that control raster function argments.

Product Availability

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

Method Summary

IStringArray	getFileList() The list of all files associated with the arguments.
IStringArray	getNames() The list of all argument names.
Object	getValue(String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
void	putValue(String name, Object value) Puts a named argument value.
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	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.

Method Detail

getValue

Object getValue(String name)
                throws IOException,
                       AutomationException

Gets a named argument value.

Product Availability

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

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putValue

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.

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

void remove(String name)
            throws IOException,
                   AutomationException

Removes a named argument value.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all argument values.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

IStringArray getNames()
                      throws IOException,
                             AutomationException

The list of all argument names.

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.

getValues

IVariantArray getValues()
                        throws IOException,
                               AutomationException

The list of all arguments.

Product Availability

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

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

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.

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

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.

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

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.

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.