IQueryDescriptor Class Referenceabstract

Defines a generic spatial search. More...

#include "IQueryDescriptor.hpp"

+ Inheritance diagram for IQueryDescriptor:

Classes

struct  IDefaults
 

Public Types

enum  Vocabulary {
  minimal, subdivision, neighborhood3d = subdivision << 1, full = (neighborhood3d << 1) - 1,
  queryOptional = neighborhood3d << 1
}
 

Public Member Functions

virtual IQueryDescriptorclone () const =0
 
virtual const char * description () const =0
 
virtual QueryType queryType () const =0
 
virtual bool hasQuery () const =0
 
virtual bool hasSampling () const =0
 
virtual bool hasSorting () const =0
 
virtual bool hasMinPtCount () const =0
 
virtual bool hasMaxSearchDistance () const =0
 
virtual const IQueryBasequery () const =0
 
virtual void query (const IQueryBase &q)=0
 
virtual const ISamplingStrategysampling () const =0
 
virtual void sampling (const ISamplingStrategy &s)=0
 
virtual const IQuerySortsorting () const =0
 
virtual void sorting (const IQuerySort &s)=0
 
virtual unsigned minPtCount () const =0
 
virtual void minPtCount (unsigned)=0
 
virtual double maxSearchDistance () const =0
 get the optional maxSearchDistance parameter. DBL_MAX for "max"
 
virtual void maxSearchDistance (double d)=0
 set the optional maxSearchDistance parameter
 
virtual double maxSearchDistance2D () const =0
 query the maximum search 2d distance based on descriptors content (considers the query object and the optional maxSearchDistance parameter) More...
 
virtual double maxSearchDistance3D () const =0
 query the maximum search 3d distance based on descriptors content (considers the query object and the optional maxSearchDistance parameter) More...
 
virtual const char * text () const =0
 
- Public Member Functions inherited from ObjectBase
virtual void Delete ()
 

Static Public Member Functions

static IQueryDescriptorNew ()
 creates an empty query descriptor object
 
static IQueryDescriptorNew (QueryBaseHandle query, const SamplingStrategyHandle &sampling=SamplingStrategyHandle(), const QuerySortHandle &sorting=QuerySortHandle(), const ParameterSetHandle &params=ParameterSetHandle())
 create a new query descriptor object
 
static IQueryDescriptorNew (const char *description, Vocabulary vocabulary=Vocabulary::minimal, const IDefaults *defaults=nullptr)
 

Static Public Attributes

static constexpr const char * ParamMinPtCount = "minPtCount"
 
static constexpr const char * ParamMaxSearchDistance = "maxSearchDistance"
 

Detailed Description

Defines a generic spatial search.

Date
2021-01
Author
wk

Member Function Documentation

◆ maxSearchDistance2D()

virtual double maxSearchDistance2D ( ) const
pure virtual

query the maximum search 2d distance based on descriptors content (considers the query object and the optional maxSearchDistance parameter)

Returns
double max if no search is unlimited

◆ maxSearchDistance3D()

virtual double maxSearchDistance3D ( ) const
pure virtual

query the maximum search 3d distance based on descriptors content (considers the query object and the optional maxSearchDistance parameter)

Returns
double max if no search is unlimited