com.esri.arcgis.spatialanalyst
Interface IGPSANeighborhood2

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GPSANeighborhood, IGPSANeighborhood2Proxy

public interface IGPSANeighborhood2
extends java.io.Serializable

COM Interface 'IGPSANeighborhood2'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description: 'Provides access to IGPSANeighborhood2 interface.' 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 IID8ab7f1bc_acb3_4048_a843_085dd5544dbe
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getType()
          The type of the neighborhood.
 int getTypeOfUnits()
          The type of units being used.
 void setAnnulus(double innerRadius, double outerRadius, int unitsType)
          Sets an annulus neighborhood object.
 void setCircle(double radius, int unitsType)
          Sets a circle neighborhood object.
 void setDefault()
          Sets a default neighborhood object.
 void setHighPassFilter()
          Sets a high-pass filter neighborhood of size of 3*3.
 void setIrregular(int height, int width, java.lang.Object entryValues)
          Sets a neighborhood object each of whose entries can be turned on or off.
 void setIrregularFile(java.lang.String fileName)
          Sets an irregular neighborhood by a file.
 void setLowPassFilter()
          Sets a low-pass filter neighborhood of size of 3*3.
 void setRectangle(double width, double height, int unitsType)
          Sets a rectangle neighborhood object.
 void setWedge(double radius, double startAngle, double endAngle, int unitsType)
          Sets a wedge neighborhood object.
 void setWeight(int height, int width, java.lang.Object entryValues)
          Sets a neighborhood object each of whose entries can be assigned a weight.
 void setWeightFile(java.lang.String fileName)
          Sets a weight neighborhood by a file.
 

Field Detail

IID8ab7f1bc_acb3_4048_a843_085dd5544dbe

static final int IID8ab7f1bc_acb3_4048_a843_085dd5544dbe
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

getType

int getType()
            throws java.io.IOException,
                   AutomationException
The type of the neighborhood.

Returns:
A com.esri.arcgis.geoanalyst.esriRasterNeighborhoodEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTypeOfUnits

int getTypeOfUnits()
                   throws java.io.IOException,
                          AutomationException
The type of units being used.

Returns:
A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefault

void setDefault()
                throws java.io.IOException,
                       AutomationException
Sets a default neighborhood object.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnulus

void setAnnulus(double innerRadius,
                double outerRadius,
                int unitsType)
                throws java.io.IOException,
                       AutomationException
Sets an annulus neighborhood object.

Parameters:
innerRadius - The innerRadius (in)
outerRadius - The outerRadius (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCircle

void setCircle(double radius,
               int unitsType)
               throws java.io.IOException,
                      AutomationException
Sets a circle neighborhood object.

Parameters:
radius - The radius (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIrregular

void setIrregular(int height,
                  int width,
                  java.lang.Object entryValues)
                  throws java.io.IOException,
                         AutomationException
Sets a neighborhood object each of whose entries can be turned on or off.

Parameters:
height - The height (in)
width - The width (in)
entryValues - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRectangle

void setRectangle(double width,
                  double height,
                  int unitsType)
                  throws java.io.IOException,
                         AutomationException
Sets a rectangle neighborhood object.

Parameters:
width - The width (in)
height - The height (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWedge

void setWedge(double radius,
              double startAngle,
              double endAngle,
              int unitsType)
              throws java.io.IOException,
                     AutomationException
Sets a wedge neighborhood object.

Parameters:
radius - The radius (in)
startAngle - The startAngle (in)
endAngle - The endAngle (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeight

void setWeight(int height,
               int width,
               java.lang.Object entryValues)
               throws java.io.IOException,
                      AutomationException
Sets a neighborhood object each of whose entries can be assigned a weight.

Parameters:
height - The height (in)
width - The width (in)
entryValues - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHighPassFilter

void setHighPassFilter()
                       throws java.io.IOException,
                              AutomationException
Sets a high-pass filter neighborhood of size of 3*3.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLowPassFilter

void setLowPassFilter()
                      throws java.io.IOException,
                             AutomationException
Sets a low-pass filter neighborhood of size of 3*3.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIrregularFile

void setIrregularFile(java.lang.String fileName)
                      throws java.io.IOException,
                             AutomationException
Sets an irregular neighborhood by a file.

Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeightFile

void setWeightFile(java.lang.String fileName)
                   throws java.io.IOException,
                          AutomationException
Sets a weight neighborhood by a file.

Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.