IFilterRegion Class Reference

Inheritance diagram for IFilterRegion:

Public Types
enum	QueryOrAnalysis { intersects, MaxQuery = intersects, intersection }
Public Types inherited from IFilter
enum	ReadAccess { coordinatesAttributes, neighbors, basePoint = neighbors << 1, full = (basePoint << 1) - 1 }
	Choose which type of data to support reading from. More...
enum	WriteAccess {   none, coordinates, attributes = coordinates << 1, coordinatesAttributes = coordinates | attributes,   delayedResults = attributes << 1, full = (delayedResults << 1) - 1 }
	Choose which type of data to support writing to. More...
enum	TriBool { indeterminate = -1, false_, true_ }
using	ResultHandle = Handle< IResult >

Static Public Member Functions
static IFilterRegion *	New (const double *coordsXY, unsigned nCoordsXY, QueryOrAnalysis queryOrAnalysis=QueryOrAnalysis::intersects)
Static Public Member Functions inherited from IFilter
static IFilter *	New ()
static IFilter *	New (const char *text, WriteAccess=WriteAccess::none, ReadAccess=ReadAccess::coordinatesAttributes)

Additional Inherited Members
Public Member Functions inherited from IFilter
virtual IFilter *	clone () const =0
virtual bool	validate (IGeometry &geom, IGeometry const *const *neighbors=0, unsigned nNeighbors=0, const IPoint *basePoint=nullptr) const =0
	Only applicable for filters (filter trees) that don't use caching. Otherwise: throw. More...
virtual bool	validate (const IGeometry &geom, IGeometry const *const *neighbors=0, unsigned nNeighbors=0, const IPoint *basePoint=nullptr) const =0
virtual void	submit (GeometryHandle geom, const void *userData=0) const =0
	Also applicable for filters (filter trees) that use caching.
virtual void	flush () const =0
virtual ResultHandle	fetch () const =0
virtual bool	mayBeValid (const IBox &box, const IAddInfoStatistics &addInfoStats) const =0
	returns false if data inside box having statistics of addInfoStats will surely not pass through (-> e.g. skip this ODM tile)
virtual TriBool	validateRange (const IBox &box, const IAddInfoStatistics &addInfoStats) const =0
virtual WindowHandle	boundingWindow () const =0
	Get the window outside which surely no data will pass through, or a default-constructed window if no such finite window exists. More...
virtual void	provideOrigObjects (bool val=true)=0
	Provides the original, unchanged geometries and attributes in Result::orig and FilterStats::accumulate.
virtual void	stats (FilterStatsHandle obj) const =0
	accumulates statistical information about the results of filtering More...
virtual FilterStatsHandle	stats () const =0
virtual bool	writesCoordinates () const =0
	returns true iff this actually writes to coordinates. More...
virtual bool	writesAttributes () const =0
	returns true iff this actually writes to attributes. More...
virtual bool	delaysResults () const =0
	returns true iff this provides delayed results. More...
virtual bool	readsNeighbors () const =0
	returns true iff this actually accesses neighbor geometries. More...
virtual bool	readsBasePoint () const =0
	returns true iff this actually accesses the base point. More...
virtual std::vector< std::string >	readAttributeNames () const =0
	returns the (case-insensitive) union of names of attributes read from geom, neighbors, or basePoint - in lexicographical order.
virtual std::vector< std::string >	writtenAttributeNames () const =0
	returns the names of attributes written to geom - in lexicographical order, and without (case-insensitive) duplicates. More...
virtual std::vector< std::string >	accessedAttributeNames () const =0
	returns the union of readAttributeNames and writtenAttributeNames.
virtual void	print (std::ostream &) const =0
virtual const char *	text () const =0
Public Member Functions inherited from ObjectBase
virtual void	Delete ()