com.esri.arcgis.datasourcesraster
Interface IExtractBandFunctionArguments2

All Superinterfaces:

IExtractBandFunctionArguments, java.io.Serializable

All Known Implementing Classes:

ExtractBandFunctionArguments, IExtractBandFunctionArguments2Proxy

public interface IExtractBandFunctionArguments2
extends IExtractBandFunctionArguments, java.io.Serializable

COM Interface 'IExtractBandFunctionArguments2'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control band extraction function argument(s).' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDee22afbb_419c_474b_bf29_457a4b9899d8
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.datasourcesraster.IExtractBandFunctionArguments

IID8de0f45a_83d0_4b7b_87ad_69aca8c11080

Method Summary

IStringArray	getBandNames() The list of bands to be extracted by name.
IDoubleArray	getBandWavelengths() The list of bands to be extracted by mid wavelength values (in nanometers).
int	getMissingBandAction() Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.
double	getWavelengthMatchTolerance() The wavelength tolerance value in nanometers.
void	init(java.lang.String sBandCombination) Initialize extract band arguments using the specified space- or semicolon-delimited band combination.
void	setBandNamesByRef(IStringArray ppBandNames) The list of bands to be extracted by name.
void	setBandWavelengthsByRef(IDoubleArray ppBandWavelengths) The list of bands to be extracted by mid wavelength values (in nanometers).
void	setMissingBandAction(int pMissingBandAction) Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.
void	setWavelengthMatchTolerance(double pWavelengthMatchTolerance) The wavelength tolerance value in nanometers.

Methods inherited from interface com.esri.arcgis.datasourcesraster.IExtractBandFunctionArguments

getBandIDs, getRaster, setBandIDsByRef, setRasterByRef

Field Detail

IIDee22afbb_419c_474b_bf29_457a4b9899d8

static final int IIDee22afbb_419c_474b_bf29_457a4b9899d8

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

init

void init(java.lang.String sBandCombination)
          throws java.io.IOException,
                 AutomationException

Initialize extract band arguments using the specified space- or semicolon-delimited band combination.

Parameters:

sBandCombination - The sBandCombination (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMissingBandAction

int getMissingBandAction()
                         throws java.io.IOException,
                                AutomationException

Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.

Returns:

A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMissingBandAction

void setMissingBandAction(int pMissingBandAction)
                          throws java.io.IOException,
                                 AutomationException

Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.

Parameters:

pMissingBandAction - A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWavelengthMatchTolerance

double getWavelengthMatchTolerance()
                                   throws java.io.IOException,
                                          AutomationException

The wavelength tolerance value in nanometers. For a raster band to be associated with a requested wavelength, the two wavelengths must lie within this tolerance.

Returns:

The pWavelengthMatchTolerance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWavelengthMatchTolerance

void setWavelengthMatchTolerance(double pWavelengthMatchTolerance)
                                 throws java.io.IOException,
                                        AutomationException

The wavelength tolerance value in nanometers. For a raster band to be associated with a requested wavelength, the two wavelengths must lie within this tolerance.

Parameters:

pWavelengthMatchTolerance - The pWavelengthMatchTolerance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandWavelengths

IDoubleArray getBandWavelengths()
                                throws java.io.IOException,
                                       AutomationException

The list of bands to be extracted by mid wavelength values (in nanometers). This property, when specified, overrides values in the 'BandIDs' property.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandWavelengthsByRef

void setBandWavelengthsByRef(IDoubleArray ppBandWavelengths)
                             throws java.io.IOException,
                                    AutomationException

The list of bands to be extracted by mid wavelength values (in nanometers). This property, when specified, overrides values in the 'BandIDs' property.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandNames

IStringArray getBandNames()
                          throws java.io.IOException,
                                 AutomationException

The list of bands to be extracted by name. This property, when specified, overrides values in the 'BandIDs' and the 'BandWavelengths' properties.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandNamesByRef

void setBandNamesByRef(IStringArray ppBandNames)
                       throws java.io.IOException,
                              AutomationException

The list of bands to be extracted by name. This property, when specified, overrides values in the 'BandIDs' and the 'BandWavelengths' properties.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.