com.esri.arcgis.spatialanalyst
Class GPSANeighborhood

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

All Implemented Interfaces:

IGPValue, com.esri.arcgis.interop.RemoteObjRef, IGPSANeighborhood, IGPSANeighborhood2, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPSANeighborhood
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPSANeighborhood, IGPSANeighborhood2, IGPValue, IClone, IXMLSerialize, IPersistStream, java.io.Externalizable

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

Description 'GeoProcessor Spatial Neighborhood object.' 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

static long

serialVersionUID

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

IID, IIDd627c1dd_a6f3_4f3a_b108_424bb3cdd57c, xxDummy

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

IID, IID8ab7f1bc_acb3_4048_a843_085dd5544dbe, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

GPSANeighborhood()
Constructs a GPSANeighborhood using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of the neighborhood.
int	getTypeOfUnits() The type of units being used.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPSANeighborhood.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAnnulus(double innerRadius, double outerRadius, int unitsType) Sets an annulus neighborhood object.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GPSANeighborhood

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

Constructs a GPSANeighborhood using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPSANeighborhood

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

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

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

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

Specified by:

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

getType

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

The type of the neighborhood.

Specified by:

getType in interface IGPSANeighborhood

Specified by:

getType in interface IGPSANeighborhood2

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

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

The type of units being used.

Specified by:

getTypeOfUnits in interface IGPSANeighborhood

Specified by:

getTypeOfUnits in interface IGPSANeighborhood2

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

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

Sets a default neighborhood object.

Specified by:

setDefault in interface IGPSANeighborhood

Specified by:

setDefault in interface IGPSANeighborhood2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnnulus

public void setAnnulus(double innerRadius,
                       double outerRadius,
                       int unitsType)
                throws java.io.IOException,
                       AutomationException

Sets an annulus neighborhood object.

Specified by:

setAnnulus in interface IGPSANeighborhood

Specified by:

setAnnulus in interface IGPSANeighborhood2

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

public void setCircle(double radius,
                      int unitsType)
               throws java.io.IOException,
                      AutomationException

Sets a circle neighborhood object.

Specified by:

setCircle in interface IGPSANeighborhood

Specified by:

setCircle in interface IGPSANeighborhood2

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

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

Specified by:

setIrregular in interface IGPSANeighborhood

Specified by:

setIrregular in interface IGPSANeighborhood2

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

public void setRectangle(double width,
                         double height,
                         int unitsType)
                  throws java.io.IOException,
                         AutomationException

Sets a rectangle neighborhood object.

Specified by:

setRectangle in interface IGPSANeighborhood

Specified by:

setRectangle in interface IGPSANeighborhood2

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

public void setWedge(double radius,
                     double startAngle,
                     double endAngle,
                     int unitsType)
              throws java.io.IOException,
                     AutomationException

Sets a wedge neighborhood object.

Specified by:

setWedge in interface IGPSANeighborhood

Specified by:

setWedge in interface IGPSANeighborhood2

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

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

Specified by:

setWeight in interface IGPSANeighborhood

Specified by:

setWeight in interface IGPSANeighborhood2

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

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

Sets a high-pass filter neighborhood of size of 3*3.

Specified by:

setHighPassFilter in interface IGPSANeighborhood

Specified by:

setHighPassFilter in interface IGPSANeighborhood2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLowPassFilter

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

Sets a low-pass filter neighborhood of size of 3*3.

Specified by:

setLowPassFilter in interface IGPSANeighborhood

Specified by:

setLowPassFilter in interface IGPSANeighborhood2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIrregularFile

public void setIrregularFile(java.lang.String fileName)
                      throws java.io.IOException,
                             AutomationException

Sets an irregular neighborhood by a file.

Specified by:

setIrregularFile in interface IGPSANeighborhood2

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWeightFile

public void setWeightFile(java.lang.String fileName)
                   throws java.io.IOException,
                          AutomationException

Sets a weight neighborhood by a file.

Specified by:

setWeightFile in interface IGPSANeighborhood2

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

empty

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

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

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

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException