|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.spatialanalyst.RasterHydrologyOp
public class RasterHydrologyOp
COM Class 'RasterHydrologyOp'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'
Description 'A mechanism for performing hydrological 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 =
| 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.IHydrologyOp |
|---|
IID, IID768f40da_de80_11d3_9f8a_00c04f8ef00e, xxDummy |
| Fields inherited from interface com.esri.arcgis.spatialanalyst.IHydrologyOp2 |
|---|
IID, IID12ea5171_d931_452a_a713_4dbf495ad07c, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo |
|---|
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy |
| Constructor Summary | |
|---|---|
RasterHydrologyOp()
Constructs a RasterHydrologyOp using ArcGIS Engine. |
|
RasterHydrologyOp(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterHydrologyOp theRasterHydrologyOp = (RasterHydrologyOp) obj; |
|
| Method Summary | |
|---|---|
IGeoDataset |
basin(IGeoDataset directionRaster)
Creates a raster delineating all drainage basins. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IGeoDataset |
fill(IGeoDataset surfaceRaster,
java.lang.Object zLimit)
Fills sinks in a surface to remove small imperfections in the data. |
IGeoDataset |
flowAccumulation(IGeoDataset directionRaster,
java.lang.Object weightRaster)
Creates a raster of accumulated flow to each cell. |
IGeoDataset |
flowAccumulationInt(IGeoDataset directionRaster,
java.lang.Object weightRaster)
Creates an integer raster of accumulated flow to each cell. |
IGeoDataset |
flowDirection(IGeoDataset surfaceRaster,
boolean createDrop,
boolean forceFlowAtEdge)
Creates a raster of flow direction from each cell to it's steepest downslope neighbor. |
IGeoDataset |
flowLength(IGeoDataset directionRaster,
boolean downStream,
java.lang.Object weightRaster)
Calculates distance, or weighted distance along a flow path. |
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 |
void |
release()
Release a RasterHydrologyOp. |
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. |
IGeoDataset |
sink(IGeoDataset directionRaster)
Creates a raster identifying all sinks, or areas of internal drainage. |
IGeoDataset |
snapPourPoint(IGeoDataset sourceDataset,
IGeoDataset accumulationRaster,
double snapDistance)
Snaps selected pour points to the cell of highest flow accumulation within a specified distance. |
IGeoDataset |
streamLink(IGeoDataset streamRaster,
IGeoDataset directionRaster)
Assigns unique values to sections of a raster linear network between intersections. |
IGeoDataset |
streamOrder(IGeoDataset streamRaster,
IGeoDataset directionRaster,
int orderType)
Assigns a numeric order to segments of a raster representing branches of a linear network. |
IGeoDataset |
streamToFeature(IGeoDataset streamRaster,
IGeoDataset directionRaster,
boolean performWeeding)
Converts a raster representing a linear network to features representing the linear network. |
IGeoDataset |
watershed(IGeoDataset directionRaster,
IGeoDataset sourceDataset)
Determines the contributing area above a set of cells in a raster. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RasterHydrologyOp()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public RasterHydrologyOp(java.lang.Object obj)
throws java.io.IOException
RasterHydrologyOp theRasterHydrologyOp = (RasterHydrologyOp) obj;
obj to RasterHydrologyOp.
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
|---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRef
public void setCellSize(int envType,
java.lang.Object cellSizeProvider)
throws java.io.IOException,
AutomationException
setCellSize in interface IRasterAnalysisEnvironmentenvType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)cellSizeProvider - A Variant (in, optional, pass null if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getCellSize(int[] envType,
double[] cellSize)
throws java.io.IOException,
AutomationException
getCellSize in interface IRasterAnalysisEnvironmentenvType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)cellSize - The cellSize (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExtent(int envType,
java.lang.Object extentProvider,
java.lang.Object snapRasterData)
throws java.io.IOException,
AutomationException
setExtent in interface IRasterAnalysisEnvironmentenvType - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getExtent(int[] envType,
IEnvelope[] extent)
throws java.io.IOException,
AutomationException
getExtent in interface IRasterAnalysisEnvironmentenvType - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaskByRef(IGeoDataset mask)
throws java.io.IOException,
AutomationException
setMaskByRef in interface IRasterAnalysisEnvironmentmask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset getMask()
throws java.io.IOException,
AutomationException
getMask in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVerifyType(int verifyType)
throws java.io.IOException,
AutomationException
setVerifyType in interface IRasterAnalysisEnvironmentverifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getVerifyType()
throws java.io.IOException,
AutomationException
getVerifyType in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getDefaultOutputRasterPrefix()
throws java.io.IOException,
AutomationException
getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultOutputRasterPrefix(java.lang.String rasterPrefix)
throws java.io.IOException,
AutomationException
setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironmentrasterPrefix - The rasterPrefix (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getDefaultOutputVectorPrefix()
throws java.io.IOException,
AutomationException
getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultOutputVectorPrefix(java.lang.String vectorPrefix)
throws java.io.IOException,
AutomationException
setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironmentvectorPrefix - The vectorPrefix (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAsNewDefaultEnvironment()
throws java.io.IOException,
AutomationException
setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restoreToPreviousDefaultEnvironment()
throws java.io.IOException,
AutomationException
restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void reset()
throws java.io.IOException,
AutomationException
reset in interface IRasterAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutWorkspaceByRef(IWorkspace workspace)
throws java.io.IOException,
AutomationException
setOutWorkspaceByRef in interface IGeoAnalysisEnvironmentworkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspace getOutWorkspace()
throws java.io.IOException,
AutomationException
getOutWorkspace in interface IGeoAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
throws java.io.IOException,
AutomationException
setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironmentspatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISpatialReference getOutSpatialReference()
throws java.io.IOException,
AutomationException
getOutSpatialReference in interface IGeoAnalysisEnvironmentjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset basin(IGeoDataset directionRaster)
throws java.io.IOException,
AutomationException
basin in interface IHydrologyOpbasin in interface IHydrologyOp2directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset fill(IGeoDataset surfaceRaster,
java.lang.Object zLimit)
throws java.io.IOException,
AutomationException
fill in interface IHydrologyOpfill in interface IHydrologyOp2surfaceRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)zLimit - A Variant (in, optional, pass null if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset flowAccumulation(IGeoDataset directionRaster,
java.lang.Object weightRaster)
throws java.io.IOException,
AutomationException
flowAccumulation in interface IHydrologyOpflowAccumulation in interface IHydrologyOp2directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)weightRaster - A Variant (in, optional, pass null if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset flowDirection(IGeoDataset surfaceRaster,
boolean createDrop,
boolean forceFlowAtEdge)
throws java.io.IOException,
AutomationException
flowDirection in interface IHydrologyOpflowDirection in interface IHydrologyOp2surfaceRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)createDrop - The createDrop (in)forceFlowAtEdge - The forceFlowAtEdge (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset flowLength(IGeoDataset directionRaster,
boolean downStream,
java.lang.Object weightRaster)
throws java.io.IOException,
AutomationException
flowLength in interface IHydrologyOpflowLength in interface IHydrologyOp2directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)downStream - The downStream (in)weightRaster - A Variant (in, optional, pass null if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset sink(IGeoDataset directionRaster)
throws java.io.IOException,
AutomationException
sink in interface IHydrologyOpsink in interface IHydrologyOp2directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset snapPourPoint(IGeoDataset sourceDataset,
IGeoDataset accumulationRaster,
double snapDistance)
throws java.io.IOException,
AutomationException
snapPourPoint in interface IHydrologyOpsnapPourPoint in interface IHydrologyOp2sourceDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)accumulationRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)snapDistance - The snapDistance (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset streamLink(IGeoDataset streamRaster,
IGeoDataset directionRaster)
throws java.io.IOException,
AutomationException
streamLink in interface IHydrologyOpstreamLink in interface IHydrologyOp2streamRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset streamOrder(IGeoDataset streamRaster,
IGeoDataset directionRaster,
int orderType)
throws java.io.IOException,
AutomationException
streamOrder in interface IHydrologyOpstreamOrder in interface IHydrologyOp2streamRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)orderType - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisStreamOrderEnum constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset streamToFeature(IGeoDataset streamRaster,
IGeoDataset directionRaster,
boolean performWeeding)
throws java.io.IOException,
AutomationException
streamToFeature in interface IHydrologyOpstreamToFeature in interface IHydrologyOp2streamRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)performWeeding - The performWeeding (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset watershed(IGeoDataset directionRaster,
IGeoDataset sourceDataset)
throws java.io.IOException,
AutomationException
watershed in interface IHydrologyOpwatershed in interface IHydrologyOp2directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)sourceDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset flowAccumulationInt(IGeoDataset directionRaster,
java.lang.Object weightRaster)
throws java.io.IOException,
AutomationException
flowAccumulationInt in interface IHydrologyOp2directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)weightRaster - A Variant (in, optional, pass null if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws java.io.IOException,
AutomationException
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||