Filter.hpp

#pragma once
 
#include <DM/IFilter.hpp>
#include <opals/String.hpp>
#include <opals/CustomOptionType.hpp>
 
namespace opals {
 
  struct FilterHandle : DM::FilterHandle {};
 
  /**
  \class Filter
 
  \tparam ReadAcc  read access
  \tparam WriteAcc write access
 
  \brief A typed version of DM::IFilter. See \ref ref_filter
 
  Derives from a handle for simplicity, but every object holds its own clone.
 
  See \ref ref_filter
 
  \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   27.07.2020
 
  */
  template<DM::IFilter::ReadAccess ReadAcc, DM::IFilter::WriteAccess WriteAcc>
  class OPALS_API Filter :
    public FilterHandle,
    public CustomOptionType<Filter<ReadAcc, WriteAcc>>
  {
  public:
    /// \name construction
    /// Constructs a new filter based on \p text.
    /** If \p text is empty or "pass", results in an empty base handle.*/
    ///@{
    Filter(const String& text = String());
    Filter(const char *text);
    Filter(const Filter&);
    ///@}
 
    Filter& operator= (const Filter&);
 
    /// The text that was passed to the constructor.
    String text() const;
 
    static const char* help(bool);
    static const char* syntax();
    static bool exportsPythonType();
  };
 
  /**
  \class FilterWithPlaceHolders
 
  \tparam ReadAcc  read access
  \tparam WriteAcc write access
 
  \brief A Filter with additional support for place holders. See \ref ref_filter
 
  Place holders are words surrounded by curly braces in \p text, to be replaced before evaluation.
 
  See \ref ref_filter
 
  \author wk
  \date   27.07.2020
 
  */
  template<DM::IFilter::ReadAccess ReadAcc, DM::IFilter::WriteAccess WriteAcc>
  class OPALS_API FilterWithPlaceHolders :
    public Filter<ReadAcc, WriteAcc>,
    public CustomOptionType<FilterWithPlaceHolders<ReadAcc, WriteAcc>>
  {
    String text_;
  public:
    /// \name construction
    /// Constructs a new filter based on \p text.
    /** If \p text is empty or "pass", results in an empty base handle.
        If \p placeHolders, constructs DM::FilterHandle with all place holders in \p text replaced with "pass".
                            Otherwise, this throws if \p text contains place holders. */
    ///@{
    FilterWithPlaceHolders(const String& text = String(), bool placeHolders = true);
    FilterWithPlaceHolders(const char *text, bool placeHolders = true);
    ///@}
 
    /// The text that was passed to the constructor (with unchanged place holders).
    String text() const;
 
    /// Returns a new filter with \p placeHolder replaced by a filter node that is equivalent to \p trafo.
    /** If this is empty, returns a filter that consists of this node only.
        Throws if this is non-empty and \p text contains no such place holder.
        Constructs the filter to be returned with \p placeHolders = furtherPlaceHolders */
    FilterWithPlaceHolders replaced(const opals::TrafPars3dAffine &trafo, const String& placeHolder = String(), bool furtherPlaceHolders = false) const;
  };
 
}