CustomOptionType.hpp

#pragma once
 
#include <opals/fwd.hpp>
 
#if 0
#define OPALS_C_DOXY_COMMENT(Arg)\
  /##** Arg *##/
#endif
 
namespace opals
{
  /**
  \class CustomOptionType
  \tparam Derived the custom parameter type implementation
 
  \brief Base class for all custom parameter types.
 
  Following the curiously recurring template pattern. Must be derived from.
 
  \author wk
  \date   05.02.2011
 
  \internal
  Derive your custom parameter type from opals::CustomOptionType with the custom parameter type as template argument,
  if the data type's help shall be appended to a parameter's module-specific long help
    - on the usage screen (--help optionName)
    - in the Python doc-string.
 
  _syntax() will be appended to _help(), if
    - it it returns a non-null pointer and
      + the module binding is not python, or
      + _exportsPythonType() returns false (see CustomOptionTypeGeneralDescription.hpp).
 
  You may also include the general help in your exception messages.
  Must be derived from (protected destructor).
  */
 
  template<class Derived>
  class CustomOptionType
  {
  public:
    /// get general help on this type
    static const char * _help(bool forDoxygen)
    {
      return Derived::help(forDoxygen);
    }
    /// get the syntax used for parsing this type
    static const char * _syntax()
    {
      return Derived::syntax();
    }
    /// returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)
    static bool _exportsPythonType()
    {
      return Derived::exportsPythonType();
    }
  protected:
    ///protected, must be derived from
    ~CustomOptionType() {}
  };
}