com.esri.arcgis.spatialanalyst
Class RasterGroundwaterOp

java.lang.Object
  com.esri.arcgis.spatialanalyst.RasterGroundwaterOp

All Implemented Interfaces:

IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, com.esri.arcgis.interop.RemoteObjRef, IGroundwaterOp, ISupportErrorInfo, java.io.Serializable

public class RasterGroundwaterOp
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IGroundwaterOp, ISupportErrorInfo

COM Class 'RasterGroundwaterOp'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description 'A mechanism for performing groundwater operations on rasters.' 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 =

See Also:

Serialized Form

Field Summary

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

IID, IID3297e9c5_93a1_11d2_9f33_00c04f8ed1d7, xxDummy

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

IID3297e9c8_93a1_11d2_9f33_00c04f8ed1d7

Fields inherited from interface com.esri.arcgis.spatialanalyst.IGroundwaterOp

IID, IID3c0ed7fb_b5c6_47cc_b708_081a5aa7a742, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

RasterGroundwaterOp()
Constructs a RasterGroundwaterOp using ArcGIS Engine.

RasterGroundwaterOp(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterGroundwaterOp theRasterGroundwaterOp = (RasterGroundwaterOp) obj;

Method Summary

IGeoDataset	darcyFlow(IGeoDataset headRaster, IGeoDataset porosityRaster, IGeoDataset thicknessRaster, IGeoDataset transmissivityRaster, boolean createDirection, boolean createMagnitude) Calculates the groundwater volume balance residual and other outputs for steady flow in an aquifer.
IGeoDataset	darcyVelocity(IGeoDataset headRaster, IGeoDataset porosityRaster, IGeoDataset thicknessRaster, IGeoDataset transmissivityRaster) Calculates the groundwater seepage velocity vector (direction and magnitude) for steady flow in an aquifer.
boolean	equals(java.lang.Object o) Compare this object with another
void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
static java.lang.String	getClsid() getClsid.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IGeoDataset	getMask() Mask allows processing to occur only for a selected set of cells.
ISpatialReference	getOutSpatialReference() The output spatial reference of GeoAnalysis.
IWorkspace	getOutWorkspace() The output workspace of GeoAnalysis.
int	getVerifyType() The verify type of the RasterAnalysis.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
IGeoDataset	particleTrack(IGeoDataset directionRaster, IGeoDataset magnitudeRaster, IPoint sourcePoint, java.lang.String trackFile, java.lang.Object stepLength, java.lang.Object trackingTime) Calculates the path of a particle through a velocity field.
IGeoDataset	porousPuff(java.lang.String trackFile, IGeoDataset porosityRaster, IGeoDataset thicknessRaster, double mass, java.lang.Object dispersionTime, java.lang.Object longitudinalDispersivity, java.lang.Object dispersivityRatio, java.lang.Object retardationFactor, java.lang.Object decayCoefficient) Calculates the time-dependent, two-dimensional concentration distribution in mass per volume of a solute introduced instantaneously and at a discrete point into a vertically mixed aquifer.
void	release() Release a RasterGroundwaterOp.
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	setOutSpatialReferenceByRef(ISpatialReference spatialReference) The output spatial reference of GeoAnalysis.
void	setOutWorkspaceByRef(IWorkspace workspace) The output workspace of GeoAnalysis.
void	setVerifyType(int verifyType) The verify type of the RasterAnalysis.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RasterGroundwaterOp

public RasterGroundwaterOp()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a RasterGroundwaterOp using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterGroundwaterOp

public RasterGroundwaterOp(java.lang.Object obj)
                    throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterGroundwaterOp theRasterGroundwaterOp = (RasterGroundwaterOp) obj;

Construct a RasterGroundwaterOp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterGroundwaterOp.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a RasterGroundwaterOp.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setCellSize

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

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

Specified by:

setCellSize in interface IRasterAnalysisEnvironment

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

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

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

Specified by:

getCellSize in interface IRasterAnalysisEnvironment

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

public 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.

Specified by:

setExtent in interface IRasterAnalysisEnvironment

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

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

Gets the type and values of extent in the RasterAnalysis.

Specified by:

getExtent in interface IRasterAnalysisEnvironment

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

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

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

Specified by:

setMaskByRef in interface IRasterAnalysisEnvironment

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

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

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

Specified by:

getMask in interface IRasterAnalysisEnvironment

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

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

The verify type of the RasterAnalysis.

Specified by:

setVerifyType in interface IRasterAnalysisEnvironment

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

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

The verify type of the RasterAnalysis.

Specified by:

getVerifyType in interface IRasterAnalysisEnvironment

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

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

The default output raster prefix.

Specified by:

getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Returns:

The rasterPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

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

The default output raster prefix.

Specified by:

setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

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

The default output vector prefix.

Specified by:

getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Returns:

The vectorPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

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

The default output vector prefix.

Specified by:

setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

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

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

Specified by:

setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

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

Restores to the previous default raster analysis environment.

Specified by:

restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Remove all previously stored default rasteranalysis environments.

Specified by:

reset in interface IRasterAnalysisEnvironment

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws java.io.IOException,
                                 AutomationException

The output workspace of GeoAnalysis.

Specified by:

setOutWorkspaceByRef in interface IGeoAnalysisEnvironment

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws java.io.IOException,
                                  AutomationException

The output workspace of GeoAnalysis.

Specified by:

getOutWorkspace in interface IGeoAnalysisEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws java.io.IOException,
                                        AutomationException

The output spatial reference of GeoAnalysis.

Specified by:

setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws java.io.IOException,
                                                AutomationException

The output spatial reference of GeoAnalysis.

Specified by:

getOutSpatialReference in interface IGeoAnalysisEnvironment

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

darcyFlow

public IGeoDataset darcyFlow(IGeoDataset headRaster,
                             IGeoDataset porosityRaster,
                             IGeoDataset thicknessRaster,
                             IGeoDataset transmissivityRaster,
                             boolean createDirection,
                             boolean createMagnitude)
                      throws java.io.IOException,
                             AutomationException

Calculates the groundwater volume balance residual and other outputs for steady flow in an aquifer.

Specified by:

darcyFlow in interface IGroundwaterOp

Parameters:

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

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

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

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

createDirection - The createDirection (in)

createMagnitude - The createMagnitude (in)

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.

darcyVelocity

public IGeoDataset darcyVelocity(IGeoDataset headRaster,
                                 IGeoDataset porosityRaster,
                                 IGeoDataset thicknessRaster,
                                 IGeoDataset transmissivityRaster)
                          throws java.io.IOException,
                                 AutomationException

Calculates the groundwater seepage velocity vector (direction and magnitude) for steady flow in an aquifer.

Specified by:

darcyVelocity in interface IGroundwaterOp

Parameters:

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

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

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

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

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.

particleTrack

public IGeoDataset particleTrack(IGeoDataset directionRaster,
                                 IGeoDataset magnitudeRaster,
                                 IPoint sourcePoint,
                                 java.lang.String trackFile,
                                 java.lang.Object stepLength,
                                 java.lang.Object trackingTime)
                          throws java.io.IOException,
                                 AutomationException

Calculates the path of a particle through a velocity field.

Specified by:

particleTrack in interface IGroundwaterOp

Parameters:

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

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

sourcePoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

trackFile - The trackFile (in)

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

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

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.

porousPuff

public IGeoDataset porousPuff(java.lang.String trackFile,
                              IGeoDataset porosityRaster,
                              IGeoDataset thicknessRaster,
                              double mass,
                              java.lang.Object dispersionTime,
                              java.lang.Object longitudinalDispersivity,
                              java.lang.Object dispersivityRatio,
                              java.lang.Object retardationFactor,
                              java.lang.Object decayCoefficient)
                       throws java.io.IOException,
                              AutomationException

Calculates the time-dependent, two-dimensional concentration distribution in mass per volume of a solute introduced instantaneously and at a discrete point into a vertically mixed aquifer.

Specified by:

porousPuff in interface IGroundwaterOp

Parameters:

trackFile - The trackFile (in)

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

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

mass - The mass (in)

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

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

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

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

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

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.