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, Externalizable, Serializable

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

GeoProcessor Spatial Neighborhood object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

See Also:

Serialized Form

Constructor Summary

GPSANeighborhood()
Constructs a GPSANeighborhood using ArcGIS Engine.

GPSANeighborhood(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(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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(ObjectInput in)
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(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, Object entryValues) Sets a neighborhood object each of whose entries can be turned on or off.
void	setIrregularFile(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, Object entryValues) Sets a neighborhood object each of whose entries can be assigned a weight.
void	setWeightFile(String fileName) Sets a weight neighborhood by a file.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GPSANeighborhood

public GPSANeighborhood()
                 throws IOException,
                        UnknownHostException

Constructs a GPSANeighborhood using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPSANeighborhood

public GPSANeighborhood(Object obj)
                 throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the neighborhood.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getType in interface IGPSANeighborhood

Specified by:

getType in interface IGPSANeighborhood2

Returns:

A com.esri.arcgis.geoanalyst.esriRasterNeighborhoodEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeOfUnits

public int getTypeOfUnits()
                   throws IOException,
                          AutomationException

The type of units being used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getTypeOfUnits in interface IGPSANeighborhood

Specified by:

getTypeOfUnits in interface IGPSANeighborhood2

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefault

public void setDefault()
                throws IOException,
                       AutomationException

Sets a default neighborhood object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

setDefault in interface IGPSANeighborhood

Specified by:

setDefault in interface IGPSANeighborhood2

Throws:

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 IOException,
                       AutomationException

Sets an annulus neighborhood object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCircle

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

Sets a circle neighborhood object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIrregular

public void setIrregular(int height,
                         int width,
                         Object entryValues)
                  throws IOException,
                         AutomationException

Sets a neighborhood object each of whose entries can be turned on or off.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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:

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 IOException,
                         AutomationException

Sets a rectangle neighborhood object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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:

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 IOException,
                     AutomationException

Sets a wedge neighborhood object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int height,
                      int width,
                      Object entryValues)
               throws IOException,
                      AutomationException

Sets a neighborhood object each of whose entries can be assigned a weight.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHighPassFilter

public void setHighPassFilter()
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

setHighPassFilter in interface IGPSANeighborhood

Specified by:

setHighPassFilter in interface IGPSANeighborhood2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowPassFilter

public void setLowPassFilter()
                      throws IOException,
                             AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

setLowPassFilter in interface IGPSANeighborhood

Specified by:

setLowPassFilter in interface IGPSANeighborhood2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIrregularFile

public void setIrregularFile(String fileName)
                      throws IOException,
                             AutomationException

Sets an irregular neighborhood by a file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

setIrregularFile in interface IGPSANeighborhood2

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeightFile

public void setWeightFile(String fileName)
                   throws IOException,
                          AutomationException

Sets a weight neighborhood by a file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

setWeightFile in interface IGPSANeighborhood2

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

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

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException