CatalogFactory.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 Catalog 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 CatalogID method for the concrete Catalog.
 */
#define DECLARE_CATALOG(classname)                                                                                     \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper                                                                                   \
      register_alg_##classname(((Mantid::API::CatalogFactory::Instance().subscribe<classname>(#classname)), 0));       \
  }
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/DllConfig.h"
#include "MantidKernel/DynamicFactory.h"
#include "MantidKernel/SingletonHolder.h"
 
namespace Mantid {
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class ICatalog;
 
class MANTID_API_DLL CatalogFactoryImpl : public Kernel::DynamicFactory<ICatalog> {
public:
  CatalogFactoryImpl(const CatalogFactoryImpl &) = delete;
  CatalogFactoryImpl &operator=(const CatalogFactoryImpl &) = delete;
 
private:
  friend struct Kernel::CreateUsingNew<CatalogFactoryImpl>;
  CatalogFactoryImpl() = default;
  ~CatalogFactoryImpl() override = default;
  mutable std::map<std::string, std::shared_ptr<ICatalog>> m_createdCatalogs;
};
 
using CatalogFactory = Mantid::Kernel::SingletonHolder<CatalogFactoryImpl>;
 
} // namespace API
} // namespace Mantid
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTID_API template class MANTID_API_DLL Mantid::Kernel::SingletonHolder<Mantid::API::CatalogFactoryImpl>;
}
} // namespace Mantid