AlgorithmManager.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/DllConfig.h"
#include "MantidKernel/SingletonHolder.h"
#include <Poco/NotificationCenter.h>
 
#include <deque>
#include <mutex>
#include <string>
#include <utility>
 
namespace Mantid {
namespace API {
 
//----------------------------------------------------------------------------
class AlgorithmStartingNotification : public Poco::Notification {
public:
  AlgorithmStartingNotification(IAlgorithm_sptr alg) : Poco::Notification(), m_alg(std::move(alg)) {}
  IAlgorithm_sptr getAlgorithm() const { return m_alg; }
 
private:
  IAlgorithm_sptr m_alg; 
};
 
//----------------------------------------------------------------------------
class MANTID_API_DLL AlgorithmManagerImpl {
public:
  IAlgorithm_sptr create(const std::string &algName, const int &version = -1);
  std::shared_ptr<Algorithm> createUnmanaged(const std::string &algName, const int &version = -1) const;
 
  std::size_t size() const;
 
  IAlgorithm_sptr getAlgorithm(AlgorithmID id) const;
  void removeById(AlgorithmID id);
 
  std::vector<IAlgorithm_const_sptr> runningInstances() const;
  std::vector<IAlgorithm_const_sptr> runningInstancesOf(const std::string &algorithmName) const;
 
  Poco::NotificationCenter notificationCenter;
  void notifyAlgorithmStarting(AlgorithmID id);
 
  void clear();
  void cancelAll();
  void shutdown();
 
private:
  friend struct Mantid::Kernel::CreateUsingNew<AlgorithmManagerImpl>;
 
  AlgorithmManagerImpl();
  ~AlgorithmManagerImpl();
 
  AlgorithmManagerImpl(const AlgorithmManagerImpl &);
  AlgorithmManagerImpl &operator=(const AlgorithmManagerImpl &);
 
  size_t removeFinishedAlgorithms();
 
  std::deque<IAlgorithm_sptr> m_managed_algs; 
  mutable std::recursive_mutex m_managedMutex;
};
 
using AlgorithmManager = Mantid::Kernel::SingletonHolder<AlgorithmManagerImpl>;
 
} // namespace API
} // Namespace Mantid
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTID_API template class MANTID_API_DLL Mantid::Kernel::SingletonHolder<Mantid::API::AlgorithmManagerImpl>;
}
} // namespace Mantid