FrameworkManager.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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
 
#include <string>
 
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/FileLoaderRegistry.h"
#include "MantidKernel/SingletonHolder.h"
#include <memory>
 
#ifdef MPI_BUILD
#include <boost/mpi/environment.hpp>
#endif
 
namespace Mantid {
 
namespace API {
class IAlgorithm;
class Workspace;
 
class MANTID_API_DLL FrameworkManagerImpl {
public:
  FrameworkManagerImpl(const FrameworkManagerImpl &) = delete;
  FrameworkManagerImpl &operator=(const FrameworkManagerImpl &) = delete;
 
  void loadPlugins();
 
  void setNumOMPThreadsToConfigValue();
  void setNumOMPThreads(const int nthreads);
  int getNumOMPThreads() const;
 
  void clear();
  void shutdown();
  void clearAlgorithms();
 
  void clearData();
 
  void clearInstruments();
 
  void clearPropertyManagers();
 
  std::shared_ptr<IAlgorithm> exec(const std::string &algorithmName, int count, ...);
 
  Workspace *getWorkspace(const std::string &wsName);
 
  bool deleteWorkspace(const std::string &wsName);
 
private:
  friend struct Mantid::Kernel::CreateUsingNew<FrameworkManagerImpl>;
 
  FrameworkManagerImpl();
  ~FrameworkManagerImpl() = default;
 
  void loadPluginsUsingKey(const std::string &locationKey, const std::string &excludeKey);
  void setGlobalNumericLocaleToC();
  void asynchronousStartupTasks();
  void setupUsageReporting();
  void updateInstrumentDefinitions();
  void checkIfNewerVersionIsAvailable();
 
#ifdef MPI_BUILD
  std::unique_ptr<boost::mpi::environment> m_mpi_environment;
  int argc = 0;
  char **argv;
#endif
};
 
using FrameworkManager = Mantid::Kernel::SingletonHolder<FrameworkManagerImpl>;
 
} // namespace API
} // namespace Mantid
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTID_API template class MANTID_API_DLL Mantid::Kernel::SingletonHolder<Mantid::API::FrameworkManagerImpl>;
}
} // namespace Mantid