ImplicitFunctionParameterParser.h

#ifndef PARAMETER_PARSER_H_
#define PARAMETER_PARSER_H_

/* Used to register classes into the factory. creates a global object in an
 * anonymous namespace. The object itself does nothing, but the comma operator
 * is used in the call to its constructor to effect a call to the factory's
 * subscribe method.
 */
//#define Parser Parser
#define DECLARE_IMPLICIT_FUNCTION_PARAMETER_PARSER(classname)                  \
  namespace {                                                                  \
  Mantid::Kernel::RegistrationHelper register_alg_##classname(                 \
      ((Mantid::API::ImplicitFunctionParameterParserFactory::Instance()        \
            .subscribe<classname>(#classname)),                                \
       0));                                                                    \
  }

//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include <vector>

#ifndef Q_MOC_RUN
#include <boost/shared_ptr.hpp>
#include <boost/interprocess/smart_ptr/unique_ptr.hpp>
#endif

#include "MantidAPI/DllConfig.h"
#include "MantidKernel/ArrayProperty.h"
#include "ImplicitFunctionParameter.h"

namespace Poco {
namespace DOM {
class Element;
}
}

/** XML Parser for parameter types for ImplicitFunctions

 @author Owen Arnold, Tessella plc
 @date 01/10/2010

 Copyright &copy; 2010 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
 National Laboratory & European Spallation Source

 This file is part of Mantid.

 Mantid is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.

 Mantid is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

 File change history is stored at: <https://github.com/mantidproject/mantid>
 Code Documentation is available at: <http://doxygen.mantidproject.org>
 */

namespace Mantid {
namespace API {

/*
 * Deletion policy for unique pointers.
 */
template <typename T> class DLLExport DeleterPolicy {
public:
  void operator()(T *pParser) { delete pParser; }
};

/*
 * ImplicitFunctionParameterParser definition. Used to parse implicit function
 * xml.
 */
class MANTID_API_DLL ImplicitFunctionParameterParser {
public:
  /// Successor type. Unique shared pointer with stack scoped deletion
  /// semantics.
  using SuccessorType = boost::interprocess::unique_ptr<
      ImplicitFunctionParameterParser,
      DeleterPolicy<ImplicitFunctionParameterParser>>;

  virtual ImplicitFunctionParameter *
  createParameter(Poco::XML::Element *parameterElement) = 0;
  virtual void
  setSuccessorParser(ImplicitFunctionParameterParser *paramParser) = 0;
  virtual ~ImplicitFunctionParameterParser() = default;

protected:
  SuccessorType m_successor;
};
}
}

#endif