WorkspaceObserver.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 "DllOption.h"
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/Workspace_fwd.h"
#include <Poco/NObserver.h>
#include <QMetaType>
#include <QObject>
 
Q_DECLARE_METATYPE(std::string)
Q_DECLARE_METATYPE(Mantid::API::Workspace_sptr)
 
//------------------------------------------------
// Mantid Forward declaration
//------------------------------------------------
 
namespace MantidQt {
namespace API {
//------------------------------------------------
// Forward declaration
//------------------------------------------------
class WorkspaceObserver;
 
class EXPORT_OPT_MANTIDQT_COMMON ObserverCallback : public QObject {
  Q_OBJECT
 
public:
  ObserverCallback(WorkspaceObserver *observer) : QObject(nullptr), m_observer(observer) {}
 
signals:
  void preDeleteRequested(const std::string &name, Mantid::API::Workspace_sptr workspace);
  void postDeleteRequested(const std::string &name);
  void addRequested(const std::string &name, Mantid::API::Workspace_sptr workspace);
  void afterReplaced(const std::string &name, Mantid::API::Workspace_sptr workspace);
  void renamed(const std::string &oldName, const std::string &newName);
  void adsCleared();
 
private slots:
  void handlePreDelete(const std::string &name, const Mantid::API::Workspace_sptr &workspace);
  void handlePostDelete(const std::string &name);
  void handleAdd(const std::string &name, const Mantid::API::Workspace_sptr &workspace);
  void handleAfterReplace(const std::string &name, const Mantid::API::Workspace_sptr &workspace);
  void handleRename(const std::string &oldName, const std::string &newName);
  void handleClearADS();
 
private:
  friend class WorkspaceObserver;
  ObserverCallback();
  WorkspaceObserver *m_observer;
};
 
class EXPORT_OPT_MANTIDQT_COMMON WorkspaceObserver {
 
public:
  WorkspaceObserver();
  virtual ~WorkspaceObserver();
  void observePreDelete(bool on = true);
  void observePostDelete(bool on = true);
  void observeAfterReplace(bool on = true);
  void observeRename(bool on = true);
  void observeAdd(bool on = true);
  void observeADSClear(bool on = true);
 
protected:
  virtual void preDeleteHandle(const std::string &wsName, const Mantid::API::Workspace_sptr &ws) {
    Q_UNUSED(wsName);
    Q_UNUSED(ws);
  }
 
  virtual void postDeleteHandle(const std::string &wsName) { Q_UNUSED(wsName); }
  virtual void addHandle(const std::string &wsName, const Mantid::API::Workspace_sptr &ws) {
    Q_UNUSED(wsName);
    Q_UNUSED(ws);
  }
  virtual void afterReplaceHandle(const std::string &wsName, const Mantid::API::Workspace_sptr &ws) {
    Q_UNUSED(wsName);
    Q_UNUSED(ws);
  }
 
  virtual void renameHandle(const std::string &oldName, const std::string &newName) {
    Q_UNUSED(oldName);
    Q_UNUSED(newName);
  }
 
  virtual void clearADSHandle() {}
 
protected:
  void _preDeleteHandle(Mantid::API::WorkspacePreDeleteNotification_ptr pNf) {
    m_proxy->preDeleteRequested(pNf->objectName(), pNf->object());
  }
  Poco::NObserver<WorkspaceObserver, Mantid::API::WorkspacePreDeleteNotification> m_preDeleteObserver;
 
  void _postDeleteHandle(Mantid::API::WorkspacePostDeleteNotification_ptr pNf) {
    m_proxy->postDeleteRequested(pNf->objectName());
  }
  Poco::NObserver<WorkspaceObserver, Mantid::API::WorkspacePostDeleteNotification> m_postDeleteObserver;
 
  void _addHandle(Mantid::API::WorkspaceAddNotification_ptr pNf) {
    m_proxy->addRequested(pNf->objectName(), pNf->object());
  }
  Poco::NObserver<WorkspaceObserver, Mantid::API::WorkspaceAddNotification> m_addObserver;
 
  void _afterReplaceHandle(Mantid::API::WorkspaceAfterReplaceNotification_ptr pNf) {
    m_proxy->afterReplaced(pNf->objectName(), pNf->object());
  }
  Poco::NObserver<WorkspaceObserver, Mantid::API::WorkspaceAfterReplaceNotification> m_afterReplaceObserver;
 
  void _renameHandle(Mantid::API::WorkspaceRenameNotification_ptr pNf) {
    m_proxy->renamed(pNf->objectName(), pNf->newObjectName());
  }
  Poco::NObserver<WorkspaceObserver, Mantid::API::WorkspaceRenameNotification> m_renameObserver;
 
  Poco::NObserver<WorkspaceObserver, Mantid::API::ClearADSNotification> m_clearADSObserver;
  void _clearADSHandle(Mantid::API::ClearADSNotification_ptr /*unused*/) { m_proxy->adsCleared(); }
 
private:
  friend class ObserverCallback;
  std::unique_ptr<ObserverCallback> m_proxy;
 
  bool m_predel_observed, m_postdel_observed, m_add_observed, m_repl_observed, m_rename_observed, m_clr_observed;
};
 
} // namespace API
} // namespace MantidQt