MDTransfFactory.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
/* Used to register unit 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.
 *
 
 * The second operation that this macro performs is to provide the definition
 * of the unitID method for the concrete unit.
 
 * Second macro does the same thing as the first one, but allow to register the
 transformation
 * with a name, different form the class name and specified by the
 transformation ID.
 */
#define DECLARE_MD_TRANSF(classname)                                                                                   \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper register_alg_##classname(                                                         \
      ((Mantid::MDAlgorithms::MDTransfFactory::Instance().subscribe<classname>(#classname)), 0));                      \
  }                                                                                                                    \
  const std::string Mantid::MDAlgorithms::classname::transfID() const { return #classname; }
 
#define DECLARE_MD_TRANSFID(classname, regID)                                                                          \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper                                                                                   \
      register_alg_##classname(((Mantid::MDAlgorithms::MDTransfFactory::Instance().subscribe<classname>(#regID)), 0)); \
  }                                                                                                                    \
  const std::string Mantid::MDAlgorithms::classname::transfID() const { return #regID; }
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidMDAlgorithms/DllConfig.h"
 
#include "MantidKernel/DynamicFactory.h"
#include "MantidKernel/SingletonHolder.h"
 
#include "MantidMDAlgorithms/MDTransfInterface.h"
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL MDTransfFactoryImpl : public Kernel::DynamicFactory<MDTransfInterface> {
public:
  std::shared_ptr<MDTransfInterface> create(const std::string &className) const override;
  MDTransfFactoryImpl(const MDTransfFactoryImpl &) = delete;
  MDTransfFactoryImpl &operator=(const MDTransfFactoryImpl &) = delete;
 
private:
  MDTransfFactoryImpl() = default;
  friend struct Kernel::CreateUsingNew<MDTransfFactoryImpl>;
  mutable std::map<std::string, std::shared_ptr<MDTransfInterface>> m_createdTransf;
};
 
using MDTransfFactory = Kernel::SingletonHolder<MDTransfFactoryImpl>;
 
} // namespace MDAlgorithms
} // namespace Mantid
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTID_MDALGORITHMS template class MANTID_MDALGORITHMS_DLL
    Mantid::Kernel::SingletonHolder<Mantid::MDAlgorithms::MDTransfFactoryImpl>;
}
} // namespace Mantid