SpatialSearch< vocabulary > Class Template Reference

A typed version of DM::IQueryDescriptor. See Generic Spatial Neighborhood Definition. More...

#include "SpatialSearch.hpp"

+ Inheritance diagram for SpatialSearch< vocabulary >:

Public Member Functions

SpatialSearchoperator= (const SpatialSearch &)
 
String text () const
 The full textual representation of this following from the text passed to the constructor, with defaults inserted.
 
construction

Constructs a new filter based on text.

 SpatialSearch (const String &text=String())
 
 SpatialSearch (const char *text)
 
 SpatialSearch (const SpatialSearch &)
 
- Public Member Functions inherited from Handle< T, Thread_safe, C, Alloc >
 Handle (const Handle &h)
 
template<class T2 , bool TS2, class C2 , class A2 >
 Handle (const Handle< T2, TS2, C2, A2 > &other)
 
template<class T2 , bool TS2, class C2 , class A2 >
 Handle (const Handle< T2, TS2, C2, A2 > &other, const use_static_cast &)
 
template<class T2 , bool TS2, class C2 , class A2 >
 Handle (const Handle< T2, TS2, C2, A2 > &other, const use_dynamic_cast &)
 
 Handle (T *p)
 
Handleoperator= (const Handle &h)
 
template<class T2 , bool TS2, class C2 , class A2 >
Handleoperator= (const Handle< T2, TS2, C2, A2 > &other)
 
Handleoperator= (T *p)
 
size_type id () const
 
 operator const T & () const
 
 operator T& ()
 
const T * ptr () const
 
const T & operator* () const
 
T & operator* ()
 
const T * operator-> () const
 
T * operator-> ()
 
bool is_shared () const
 
get_count () const
 
T * release ()
 
void swap (Handle &h)
 
void reset ()
 
Handle clone () const
 
bool operator== (const Handle &h) const
 
bool operator!= (const Handle &h) const
 
bool operator> (const Handle &h) const
 
bool operator< (const Handle &h) const
 
 operator unspecified_bool_type () const
 

Static Public Member Functions

static const char * help (bool)
 
static const char * syntax ()
 
static bool exportsPythonType ()
 
- Static Public Member Functions inherited from CustomOptionType< SpatialSearch< vocabulary > >
static const char * _help (bool forDoxygen)
 get general help on this type
 
static const char * _syntax ()
 get the syntax used for parsing this type
 
static bool _exportsPythonType ()
 returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)
 

Additional Inherited Members

- Public Types inherited from Handle< T, Thread_safe, C, Alloc >
typedef T element_type
 
- Public Attributes inherited from Handle< T, Thread_safe, C, Alloc >
const typedef T *(self::* unspecified_bool_type )() const
 
- Protected Member Functions inherited from CustomOptionType< SpatialSearch< vocabulary > >
 ~CustomOptionType ()
 protected, must be derived from
 

Detailed Description

template<DM::IQueryDescriptor::Vocabulary vocabulary>
class opals::SpatialSearch< vocabulary >

A typed version of DM::IQueryDescriptor. See Generic Spatial Neighborhood Definition.

Template Parameters
Vocabularyvocabulary

Derives from a handle for simplicity, but every object holds its own clone.

See Generic Spatial Neighborhood Definition

Constructor & Destructor Documentation

◆ SpatialSearch()

SpatialSearch ( const String text = String())

If text is empty, results in an empty base handle.