com.esri.arcgis.geoanalyst
Interface IRasterAnalysisEnvironment

All Superinterfaces:

IGeoAnalysisEnvironment, java.io.Serializable

All Known Implementing Classes:

GridTableOp, IRasterAnalysisEnvironmentProxy, RasterAnalysis, RasterConditionalOp, RasterConversionOp, RasterDensityOp, RasterDistanceOp, RasterExtractionOp, RasterGeneralizeOp, RasterGroundwaterOp, RasterHydrologyOp, RasterInterpolationOp, RasterLocalOp, RasterMakerOp, RasterMapAlgebraOp, RasterMathOps, RasterMathSupportOp, RasterModel, RasterMultivariateOp, RasterNeighborhoodOp, RasterReclassOp, RasterSurfaceOp, RasterTransformationOp, RasterZonalOp

public interface IRasterAnalysisEnvironment
extends IGeoAnalysisEnvironment, java.io.Serializable

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

Description: 'Provides access to members that control the environment for raster analysis.' 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	IID3297e9c5_93a1_11d2_9f33_00c04f8ed1d7
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.geoanalyst.IGeoAnalysisEnvironment

IID3297e9c8_93a1_11d2_9f33_00c04f8ed1d7

Method Summary

void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
java.lang.String	getDefaultOutputRasterPrefix() The default output raster prefix.
java.lang.String	getDefaultOutputVectorPrefix() The default output vector prefix.
void	getExtent(int[] envType, IEnvelope[] extent) Gets the type and values of extent in the RasterAnalysis.
IGeoDataset	getMask() Mask allows processing to occur only for a selected set of cells.
int	getVerifyType() The verify type of the RasterAnalysis.
void	reset() Remove all previously stored default rasteranalysis environments.
void	restoreToPreviousDefaultEnvironment() Restores to the previous default raster analysis environment.
void	setAsNewDefaultEnvironment() Sets the raster analysis environment of the object as new default environment.
void	setCellSize(int envType, java.lang.Object cellSizeProvider) Sets the type and value of cell size in the RasterAnalysis.
void	setDefaultOutputRasterPrefix(java.lang.String rasterPrefix) The default output raster prefix.
void	setDefaultOutputVectorPrefix(java.lang.String vectorPrefix) The default output vector prefix.
void	setExtent(int envType, java.lang.Object extentProvider, java.lang.Object snapRasterData) Sets the type and values of extent in the RasterAnalysis.
void	setMaskByRef(IGeoDataset mask) Mask allows processing to occur only for a selected set of cells.
void	setVerifyType(int verifyType) The verify type of the RasterAnalysis.

Methods inherited from interface com.esri.arcgis.geoanalyst.IGeoAnalysisEnvironment

getOutSpatialReference, getOutWorkspace, setOutSpatialReferenceByRef, setOutWorkspaceByRef

Field Detail

IID3297e9c5_93a1_11d2_9f33_00c04f8ed1d7

static final int IID3297e9c5_93a1_11d2_9f33_00c04f8ed1d7

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

setCellSize

void setCellSize(int envType,
                 java.lang.Object cellSizeProvider)
                 throws java.io.IOException,
                        AutomationException

Sets the type and value of cell size in the RasterAnalysis.

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

cellSizeProvider - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCellSize

void getCellSize(int[] envType,
                 double[] cellSize)
                 throws java.io.IOException,
                        AutomationException

Gets the type and value of cell size in the RasterAnalysis.

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

cellSize - The cellSize (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(int envType,
               java.lang.Object extentProvider,
               java.lang.Object snapRasterData)
               throws java.io.IOException,
                      AutomationException

Sets the type and values of extent in the RasterAnalysis.

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

extentProvider - A Variant (in, optional, pass null if not required)

snapRasterData - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

void getExtent(int[] envType,
               IEnvelope[] extent)
               throws java.io.IOException,
                      AutomationException

Gets the type and values of extent in the RasterAnalysis.

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaskByRef

void setMaskByRef(IGeoDataset mask)
                  throws java.io.IOException,
                         AutomationException

Mask allows processing to occur only for a selected set of cells.

Parameters:

mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMask

IGeoDataset getMask()
                    throws java.io.IOException,
                           AutomationException

Mask allows processing to occur only for a selected set of cells.

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVerifyType

void setVerifyType(int verifyType)
                   throws java.io.IOException,
                          AutomationException

The verify type of the RasterAnalysis.

Parameters:

verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVerifyType

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

The verify type of the RasterAnalysis.

Returns:

A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

java.lang.String getDefaultOutputRasterPrefix()
                                              throws java.io.IOException,
                                                     AutomationException

The default output raster prefix.

Returns:

The rasterPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

void setDefaultOutputRasterPrefix(java.lang.String rasterPrefix)
                                  throws java.io.IOException,
                                         AutomationException

The default output raster prefix.

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

java.lang.String getDefaultOutputVectorPrefix()
                                              throws java.io.IOException,
                                                     AutomationException

The default output vector prefix.

Returns:

The vectorPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

void setDefaultOutputVectorPrefix(java.lang.String vectorPrefix)
                                  throws java.io.IOException,
                                         AutomationException

The default output vector prefix.

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

void setAsNewDefaultEnvironment()
                                throws java.io.IOException,
                                       AutomationException

Sets the raster analysis environment of the object as new default environment.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

void restoreToPreviousDefaultEnvironment()
                                         throws java.io.IOException,
                                                AutomationException

Restores to the previous default raster analysis environment.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws java.io.IOException,
                  AutomationException

Remove all previously stored default rasteranalysis environments.

Throws:

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

AutomationException - If the ArcObject component throws an exception.