com.esri.arcgis.datasourcesraster
Interface IPixelFilterCollection

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultibandFilter, PixelFilterCollection

public interface IPixelFilterCollection
extends Serializable

Provides access to members that control a raster filter collection.

Product Availability

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

See Also:

IPixelOperation, IPixelFilter

Method Summary

void	append(IPixelFilter pFilter) Appends a raster filter to the end.
void	empty() Empties this raster filter collection.
int	find(IPixelFilter pFilter) Finds a given raster filter and returns its index position.
IPixelFilter	get(int index) Gets the raster filter at a given index position.
int	getFilterCount() The number of filters in this collection.
void	insert(int index, IPixelFilter pFilter) Inserts a raster filter at a given index.
void	remove(int index) Removes a raster filter at a given index.
void	set(int index, IPixelFilter pFilter) Sets the raster filter at a given index position.

Method Detail

getFilterCount

int getFilterCount()
                   throws IOException,
                          AutomationException

The number of filters in this collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IPixelFilter pFilter)
            throws IOException,
                   AutomationException

Inserts a raster filter at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

append

void append(IPixelFilter pFilter)
            throws IOException,
                   AutomationException

Appends a raster filter to the end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes a raster filter at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

int find(IPixelFilter pFilter)
         throws IOException,
                AutomationException

Finds a given raster filter and returns its index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

get

IPixelFilter get(int index)
                 throws IOException,
                        AutomationException

Gets the raster filter at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

set

void set(int index,
         IPixelFilter pFilter)
         throws IOException,
                AutomationException

Sets the raster filter at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws IOException,
                  AutomationException

Empties this raster filter collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.