UnitFactory.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.
 */
#define DECLARE_UNIT(classname)                                                                                        \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper                                                                                   \
      register_unit_##classname(((Mantid::Kernel::UnitFactory::Instance().subscribe<classname>(#classname)), 0));      \
  }                                                                                                                    \
  const std::string Mantid::Kernel::Units::classname::unitID() const { return #classname; }
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/DynamicFactory.h"
#include "MantidKernel/SingletonHolder.h"
#include "MantidKernel/Unit.h"
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL UnitFactoryImpl final : public DynamicFactory<Unit> {
public:
  UnitFactoryImpl(const UnitFactoryImpl &) = delete;
  UnitFactoryImpl &operator=(const UnitFactoryImpl &) = delete;
 
  const std::vector<std::string> getConvertibleUnits() const {
    std::vector<std::string> convertibleUnits;
 
    for (const auto &unitKey : getKeys()) {
      const auto unit_sptr = create(unitKey);
      if (unit_sptr->isConvertible()) {
        convertibleUnits.emplace_back(unitKey);
      }
    }
 
    return convertibleUnits;
  }
 
private:
  friend struct CreateUsingNew<UnitFactoryImpl>;
 
  UnitFactoryImpl() = default;
 
  ~UnitFactoryImpl() override = default;
};
 
EXTERN_MANTID_KERNEL template class MANTID_KERNEL_DLL Mantid::Kernel::SingletonHolder<UnitFactoryImpl>;
 
using UnitFactory = SingletonHolder<UnitFactoryImpl>;
 
} // namespace Kernel
} // namespace Mantid