Calculator.hpp

#pragma once
 
#include <DM/ICalculator.hpp>
#include <opals/String.hpp>
#include <opals/CustomOptionType.hpp>
 
namespace opals {
 
  struct CalculatorHandle : DM::CalculatorHandle {};
 
  /**
  \class Calculator
 
  \tparam ReadAcc  read access
  \tparam WriteAcc write access
 
  \brief A typed version of DM::ICalculator. See \ref ref_calculator
 
  Derives from a handle for simplicity, but every object holds its own clone.
 
  See \ref ref_calculator
 
  \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::ICalculator::ReadAccess ReadAcc, DM::ICalculator::WriteAccess WriteAcc>
  class OPALS_API Calculator :
    public CalculatorHandle,
    public CustomOptionType<Calculator<ReadAcc, WriteAcc>>
  {
  public:
    /// \name construction
    /// Constructs a new calculator based on \p text.
    /** If \p text is empty or "pass", results in an empty base handle.*/
    ///@{
    Calculator(const String& text = String());
    Calculator(const char *text);
    Calculator(const Calculator&);
    ///@}
 
    Calculator& operator= (const Calculator&);
 
    /// The text that was passed to the constructor.
    String text() const;
 
    static const char* help(bool);
    static const char* syntax();
    static bool exportsPythonType();
  };
 
  /**
  \class CalculatorWithPythonSupport
 
  \tparam ReadAcc  read access
  \tparam WriteAcc write access
 
  \brief A Calculator that alternatively supports Python formulas. See \ref ref_calculator
 
  Prefix \p text with pythonPrefix() to indicate usage of Python syntax.
 
  See \ref ref_calculator
 
  \author wk
  \date   27.07.2020
 
  */
  template<DM::ICalculator::ReadAccess ReadAcc, DM::ICalculator::WriteAccess WriteAcc>
  class OPALS_API CalculatorWithPythonSupport :
    public Calculator<ReadAcc, WriteAcc>,
    public CustomOptionType<CalculatorWithPythonSupport<ReadAcc, WriteAcc>>
  {
    String text_;
  public:
    /// \name construction
    /// Constructs a new calculator based on \p text.
    ///@{
    CalculatorWithPythonSupport(const String& text = String());
    CalculatorWithPythonSupport(const char *text);
    ///@}
 
    /// The text that was passed to the constructor.
    String text() const;
 
    /// Returns true if \p text starts with "python:"
    bool isPythonFormula() const;
    /// \p text without the prefix indicating Python syntax.
    String pyText() const;
 
    static const char* help(bool);
  };
 
}