com.esri.arcgis.spatialanalyst
Class RasterDistanceOp

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

All Implemented Interfaces:

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

public class RasterDistanceOp
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IDistanceOp, IDistanceOp2, ISupportErrorInfo

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

Description 'A mechanism for performing distance 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.IDistanceOp

IID, IID4606f16d_b47d_11d2_9f3b_00c04f8ed1d7, xxDummy

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

IID, IIDd4ee724a_05fc_4db3_9be8_b2b7c07bb70c, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

RasterDistanceOp()
Constructs a RasterDistanceOp using ArcGIS Engine.

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

Method Summary

IGeoDataset	corridor(IGeoDataset distance1, IGeoDataset distance2) Calculates for each cell location the sum of the accumulative costs for two input accumulative-cost datasets.
IGeoDataset	costAllocation(IGeoDataset sourceData, IGeoDataset costRaster, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each output cell the zone that could be reached with the least accumulative cost.
IGeoDataset	costBackLink(IGeoDataset sourceData, IGeoDataset costRaster, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates the neighbor that is the next cell on the least-accumulative-cost path from a cell to a source cell.
IGeoDataset	costDistance(IGeoDataset sourceData, IGeoDataset costRaster, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the least-accumulative-cost distance over a cost surface to a source cell or a set of source cells.
IGeoDataset	costDistanceFull(IGeoDataset sourceData, IGeoDataset costRaster, boolean distance, boolean backlink, boolean allocation, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the least-accumulative-cost distance, backlink, and allocation over a cost surface to a source cell or a set of source cells.
IGeoDataset	costPath(IGeoDataset fromData, IGeoDataset distance, IGeoDataset backlink, int pathType) Calculates the least-cost path(s) from selected cell(s) in the input data to the closest source cell.
IGeometryCollection	costPathAsPolyline(IPointCollection sourcePoints, IGeoDataset distance, IGeoDataset backlink) Calculates the least-cost path(s) from selected points in the input data and returns it as a polyline.
boolean	equals(java.lang.Object o) Compare this object with another
IGeoDataset	eucAllocation(IGeoDataset sourceData, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the zone of the closest source cell (in Euclidean distance).
IGeoDataset	eucDirection(IGeoDataset sourceData, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates the direction in degrees from each cell center to the cell center of the closest source.
IGeoDataset	eucDistance(IGeoDataset sourceData, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the Euclidean distance to the closest source.
IGeoDataset	eucDistanceFull(IGeoDataset sourceData, boolean distance, boolean direction, boolean allocation, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell optionally the Euclidean distance, direction, and allocation to the closest source.
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	pathAllocation(IGeoDataset sourceData, java.lang.Object costRaster, java.lang.Object surfaceRaster, java.lang.Object horizRaster, java.lang.Object horizFactor, java.lang.Object vertRaster, java.lang.Object vertFactor, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each output cell the zone that could be reached with the least accumulative cost.
IGeoDataset	pathBackLink(IGeoDataset sourceData, java.lang.Object costRaster, java.lang.Object surfaceRaster, java.lang.Object horizRaster, java.lang.Object horizFactor, java.lang.Object vertRaster, java.lang.Object vertFactor, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates the neighbor that is the next cell on the least-accumulative-path path from a cell to a source cell.
IGeoDataset	pathDistance(IGeoDataset sourceData, java.lang.Object costRaster, java.lang.Object surfaceRaster, java.lang.Object horizRaster, java.lang.Object horizFactor, java.lang.Object vertRaster, java.lang.Object vertFactor, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the least-accumulative-path distance over a path surface to a source cell or a set of source cells.
IGeoDataset	pathDistanceFull(IGeoDataset sourceData, boolean distance, boolean backlink, boolean allocation, java.lang.Object costRaster, java.lang.Object surfaceRaster, java.lang.Object horizRaster, java.lang.Object horizFactor, java.lang.Object vertRaster, java.lang.Object vertFactor, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the least-accumulative-cost distance, backlink, and allocation over a cost surface to a source cell or a set of source cells.
void	release() Release a RasterDistanceOp.
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

RasterDistanceOp

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

Constructs a RasterDistanceOp using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterDistanceOp

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

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

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

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

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.

eucDistance

public IGeoDataset eucDistance(IGeoDataset sourceData,
                               java.lang.Object maxDistance,
                               java.lang.Object valueRaster)
                        throws java.io.IOException,
                               AutomationException

Calculates for each cell the Euclidean distance to the closest source.

Specified by:

eucDistance in interface IDistanceOp

Specified by:

eucDistance in interface IDistanceOp2

Parameters:

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

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

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

eucDistanceFull

public IGeoDataset eucDistanceFull(IGeoDataset sourceData,
                                   boolean distance,
                                   boolean direction,
                                   boolean allocation,
                                   java.lang.Object maxDistance,
                                   java.lang.Object valueRaster)
                            throws java.io.IOException,
                                   AutomationException

Calculates for each cell optionally the Euclidean distance, direction, and allocation to the closest source.

Specified by:

eucDistanceFull in interface IDistanceOp

Specified by:

eucDistanceFull in interface IDistanceOp2

Parameters:

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

distance - The distance (in)

direction - The direction (in)

allocation - The allocation (in)

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

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

eucAllocation

public IGeoDataset eucAllocation(IGeoDataset sourceData,
                                 java.lang.Object maxDistance,
                                 java.lang.Object valueRaster)
                          throws java.io.IOException,
                                 AutomationException

Calculates for each cell the zone of the closest source cell (in Euclidean distance).

Specified by:

eucAllocation in interface IDistanceOp

Specified by:

eucAllocation in interface IDistanceOp2

Parameters:

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

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

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

eucDirection

public IGeoDataset eucDirection(IGeoDataset sourceData,
                                java.lang.Object maxDistance,
                                java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates the direction in degrees from each cell center to the cell center of the closest source.

Specified by:

eucDirection in interface IDistanceOp

Specified by:

eucDirection in interface IDistanceOp2

Parameters:

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

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

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

costDistance

public IGeoDataset costDistance(IGeoDataset sourceData,
                                IGeoDataset costRaster,
                                java.lang.Object maxDistance,
                                java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates for each cell the least-accumulative-cost distance over a cost surface to a source cell or a set of source cells.

Specified by:

costDistance in interface IDistanceOp

Specified by:

costDistance in interface IDistanceOp2

Parameters:

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

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

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

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

costAllocation

public IGeoDataset costAllocation(IGeoDataset sourceData,
                                  IGeoDataset costRaster,
                                  java.lang.Object maxDistance,
                                  java.lang.Object valueRaster)
                           throws java.io.IOException,
                                  AutomationException

Calculates for each output cell the zone that could be reached with the least accumulative cost.

Specified by:

costAllocation in interface IDistanceOp

Specified by:

costAllocation in interface IDistanceOp2

Parameters:

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

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

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

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

costBackLink

public IGeoDataset costBackLink(IGeoDataset sourceData,
                                IGeoDataset costRaster,
                                java.lang.Object maxDistance,
                                java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates the neighbor that is the next cell on the least-accumulative-cost path from a cell to a source cell.

Specified by:

costBackLink in interface IDistanceOp

Specified by:

costBackLink in interface IDistanceOp2

Parameters:

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

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

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

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

costDistanceFull

public IGeoDataset costDistanceFull(IGeoDataset sourceData,
                                    IGeoDataset costRaster,
                                    boolean distance,
                                    boolean backlink,
                                    boolean allocation,
                                    java.lang.Object maxDistance,
                                    java.lang.Object valueRaster)
                             throws java.io.IOException,
                                    AutomationException

Calculates for each cell the least-accumulative-cost distance, backlink, and allocation over a cost surface to a source cell or a set of source cells.

Specified by:

costDistanceFull in interface IDistanceOp

Specified by:

costDistanceFull in interface IDistanceOp2

Parameters:

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

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

distance - The distance (in)

backlink - The backlink (in)

allocation - The allocation (in)

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

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

corridor

public IGeoDataset corridor(IGeoDataset distance1,
                            IGeoDataset distance2)
                     throws java.io.IOException,
                            AutomationException

Calculates for each cell location the sum of the accumulative costs for two input accumulative-cost datasets.

Specified by:

corridor in interface IDistanceOp

Specified by:

corridor in interface IDistanceOp2

Parameters:

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

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

costPath

public IGeoDataset costPath(IGeoDataset fromData,
                            IGeoDataset distance,
                            IGeoDataset backlink,
                            int pathType)
                     throws java.io.IOException,
                            AutomationException

Calculates the least-cost path(s) from selected cell(s) in the input data to the closest source cell.

Specified by:

costPath in interface IDistanceOp

Specified by:

costPath in interface IDistanceOp2

Parameters:

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

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

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

pathType - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisPathEnum constant (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.

costPathAsPolyline

public IGeometryCollection costPathAsPolyline(IPointCollection sourcePoints,
                                              IGeoDataset distance,
                                              IGeoDataset backlink)
                                       throws java.io.IOException,
                                              AutomationException

Calculates the least-cost path(s) from selected points in the input data and returns it as a polyline.

Specified by:

costPathAsPolyline in interface IDistanceOp

Specified by:

costPathAsPolyline in interface IDistanceOp2

Parameters:

sourcePoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pathDistance

public IGeoDataset pathDistance(IGeoDataset sourceData,
                                java.lang.Object costRaster,
                                java.lang.Object surfaceRaster,
                                java.lang.Object horizRaster,
                                java.lang.Object horizFactor,
                                java.lang.Object vertRaster,
                                java.lang.Object vertFactor,
                                java.lang.Object maxDistance,
                                java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates for each cell the least-accumulative-path distance over a path surface to a source cell or a set of source cells.

Specified by:

pathDistance in interface IDistanceOp2

Parameters:

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

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

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

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

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

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

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

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

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

pathAllocation

public IGeoDataset pathAllocation(IGeoDataset sourceData,
                                  java.lang.Object costRaster,
                                  java.lang.Object surfaceRaster,
                                  java.lang.Object horizRaster,
                                  java.lang.Object horizFactor,
                                  java.lang.Object vertRaster,
                                  java.lang.Object vertFactor,
                                  java.lang.Object maxDistance,
                                  java.lang.Object valueRaster)
                           throws java.io.IOException,
                                  AutomationException

Calculates for each output cell the zone that could be reached with the least accumulative cost.

Specified by:

pathAllocation in interface IDistanceOp2

Parameters:

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

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

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

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

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

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

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

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

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

pathBackLink

public IGeoDataset pathBackLink(IGeoDataset sourceData,
                                java.lang.Object costRaster,
                                java.lang.Object surfaceRaster,
                                java.lang.Object horizRaster,
                                java.lang.Object horizFactor,
                                java.lang.Object vertRaster,
                                java.lang.Object vertFactor,
                                java.lang.Object maxDistance,
                                java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates the neighbor that is the next cell on the least-accumulative-path path from a cell to a source cell.

Specified by:

pathBackLink in interface IDistanceOp2

Parameters:

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

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

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

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

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

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

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

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

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

pathDistanceFull

public IGeoDataset pathDistanceFull(IGeoDataset sourceData,
                                    boolean distance,
                                    boolean backlink,
                                    boolean allocation,
                                    java.lang.Object costRaster,
                                    java.lang.Object surfaceRaster,
                                    java.lang.Object horizRaster,
                                    java.lang.Object horizFactor,
                                    java.lang.Object vertRaster,
                                    java.lang.Object vertFactor,
                                    java.lang.Object maxDistance,
                                    java.lang.Object valueRaster)
                             throws java.io.IOException,
                                    AutomationException

Calculates for each cell the least-accumulative-cost distance, backlink, and allocation over a cost surface to a source cell or a set of source cells.

Specified by:

pathDistanceFull in interface IDistanceOp2

Parameters:

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

distance - The distance (in)

backlink - The backlink (in)

allocation - The allocation (in)

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

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

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

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

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

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

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

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