com.esri.arcgis.geodatabaseextensions
Class LasFilter

java.lang.Object
  com.esri.arcgis.geodatabaseextensions.LasFilter

All Implemented Interfaces:

ILasAttributeFilter, ILasFilter, ILasPointFilter, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class LasFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILasPointFilter, ILasAttributeFilter, ILasFilter, IPersist, IPersistStream, Externalizable

Esri LasFilter component.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

LasFilter()
Constructs a LasFilter using ArcGIS Engine.

LasFilter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LasFilter theLasFilter = (LasFilter) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
ILasFilter	esri_clone() Make a clone.
IGeometry	getAreaOfInterest() The area of interest.
ILongArray	getClassCodes() The classification codes.
int	getClassFlags() The classification flags.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ILongArray	getReturns() The return numbers.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IArray	getSurfaceConstraints() The surface constraints to be applied.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAreaOfInterestByRef(IGeometry ppAOI) The area of interest.
void	setClassCodes(ILongArray ppCodes) The classification codes.
void	setClassFlags(int pFlags) The classification flags.
void	setReturns(ILongArray ppReturns) The return numbers.
void	setSurfaceConstraints(IArray ppConstraintIDs) The surface constraints to be applied.
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

LasFilter

public LasFilter()
          throws IOException,
                 UnknownHostException

Constructs a LasFilter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LasFilter

public LasFilter(Object obj)
          throws IOException

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

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

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

setAreaOfInterestByRef

public void setAreaOfInterestByRef(IGeometry ppAOI)
                            throws IOException,
                                   AutomationException

The area of interest.

Product Availability

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

Specified by:

setAreaOfInterestByRef in interface ILasPointFilter

Parameters:

ppAOI - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IGeometry getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The area of interest.

Description

AreaOfInterest represents the spatial extent of the filter. Points within the XY extent of the envelope are considered for inclusion by the filter. The Z range, if set, is ignored.

Product Availability

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

Specified by:

getAreaOfInterest in interface ILasPointFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturns

public void setReturns(ILongArray ppReturns)
                throws IOException,
                       AutomationException

The return numbers.

Product Availability

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

Specified by:

setReturns in interface ILasAttributeFilter

Parameters:

ppReturns - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturns

public ILongArray getReturns()
                      throws IOException,
                             AutomationException

The return numbers.

Description

Returns is a LongArray containing the lidar return numbers of interest. Any point with a return equal to one of the values in the passed array is considered for inclusion by the filter. The valid return number range is 1-5.

Product Availability

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

Specified by:

getReturns in interface ILasAttributeFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassCodes

public void setClassCodes(ILongArray ppCodes)
                   throws IOException,
                          AutomationException

The classification codes.

Product Availability

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

Specified by:

setClassCodes in interface ILasAttributeFilter

Parameters:

ppCodes - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCodes

public ILongArray getClassCodes()
                         throws IOException,
                                AutomationException

The classification codes.

Description

ClassCodes is a LongArray containing the LAS classification codes of interest. Any point with a code equal to one of the values in the passed array is considered for inclusion by the filter. The valid LAS class code range is 0-31 for Las file versions 1.1, 1.2, 1.3 and 0-255 for version 1.0.

Product Availability

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

Specified by:

getClassCodes in interface ILasAttributeFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassFlags

public void setClassFlags(int pFlags)
                   throws IOException,
                          AutomationException

The classification flags.

Product Availability

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

Specified by:

setClassFlags in interface ILasAttributeFilter

Parameters:

pFlags - The pFlags (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassFlags

public int getClassFlags()
                  throws IOException,
                         AutomationException

The classification flags.

Description

ClassFlags is used to specify which points, based on their LAS classification flag settings, are considered for inclusion by the filter. The LAS specification supports three class flag types: synthetic, key-point, and witheld. The value can be set equal to one of the constants defined in the esriLasClassFlag enumeration. You can also set the value to the result of a bitwise operation performed on these same constants in order to use them in combination.

Product Availability

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

Specified by:

getClassFlags in interface ILasAttributeFilter

Returns:

The pFlags

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSurfaceConstraints

public void setSurfaceConstraints(IArray ppConstraintIDs)
                           throws IOException,
                                  AutomationException

The surface constraints to be applied.

Product Availability

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

Specified by:

setSurfaceConstraints in interface ILasFilter

Parameters:

ppConstraintIDs - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSurfaceConstraints

public IArray getSurfaceConstraints()
                             throws IOException,
                                    AutomationException

The surface constraints to be applied.

Description

SurfaceConstraints is an esriSystem.Array containing the UIDs of the feature classes participating in the las dataset that should be considered 'active', or turned on, by the filter. This allows the filter to activate just some of the contraints for a given operation (e.g., enforcing water body polygons but not edge of pavement lines when retrieving a TIN from the las dataset via ILasSurface.AsTin). The UIDs of the constraint feature classes can be obtained via ILasDataset.GetSurfaceConstraintID.

Product Availability

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

Specified by:

getSurfaceConstraints in interface ILasFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public ILasFilter esri_clone()
                      throws IOException,
                             AutomationException

Make a clone.

Product Availability

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

Specified by:

esri_clone in interface ILasFilter

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ILasFilter

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.

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.

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