SpatialSearch.hpp

#pragma once
 
#include <DM/IQueryDescriptor.hpp>
#include <opals/CustomOptionType.hpp>
#include <opals/String.hpp>
 
namespace opals
{
 
  struct SpatialSearchHandle : DM::QueryDescriptorHandle
  {
    using DM::QueryDescriptorHandle::QueryDescriptorHandle;
  };
 
  /**
  \class SpatialSearch
 
  \tparam Vocabulary vocabulary
 
  \brief A typed version of DM::IQueryDescriptor. See \ref ref_neighborhood
 
  Derives from a handle for simplicity, but every object holds its own clone.
 
  See \ref ref_neighborhood
 
  \internal
  Behaves like an object and not like a handle, because this should be usable as element type of containers (with independent elements).
 
  \author wk
  \date   25.10.2024
 
  */
  template<DM::IQueryDescriptor::Vocabulary vocabulary>
  class OPALS_API SpatialSearch :
    public SpatialSearchHandle,
    public CustomOptionType<SpatialSearch<vocabulary>>
  {
  public:
    /// \name construction
    /// Constructs a new filter based on \p text.
    /** If \p text is empty, results in an empty base handle.*/
    ///@{
    SpatialSearch(const String& text = String());
    SpatialSearch(const char *text);
    SpatialSearch(const SpatialSearch&);
    ///@}
 
    SpatialSearch& operator=(const SpatialSearch&);
 
    /// The full textual representation of this following from the text passed to the constructor, with defaults inserted.
    String text() const;
 
    static const char* help(bool);
    static const char* syntax();
    static bool exportsPythonType();
  };
 
}