WorkspaceSelector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 <QComboBox>
#include <QStringList>
#include <mutex>
 
#include <Poco/AutoPtr.h>
#include <Poco/NObserver.h>
 
// Forward declarations
namespace Mantid {
namespace API {
class Algorithm;
}
} // namespace Mantid
 
namespace MantidQt {
namespace MantidWidgets {
class EXPORT_OPT_MANTIDQT_COMMON WorkspaceSelector : public QComboBox {
  Q_OBJECT
 
  Q_PROPERTY(QStringList WorkspaceTypes READ getWorkspaceTypes WRITE setWorkspaceTypes)
  Q_PROPERTY(bool ShowHidden READ showHiddenWorkspaces WRITE showHiddenWorkspaces)
  Q_PROPERTY(bool ShowGroups READ showWorkspaceGroups WRITE showWorkspaceGroups)
  Q_PROPERTY(bool Optional READ isOptional WRITE setOptional)
  Q_PROPERTY(bool Sorted READ isSorted WRITE setSorted)
  Q_PROPERTY(QStringList Suffix READ getSuffixes WRITE setSuffixes)
  Q_PROPERTY(QString Algorithm READ getValidatingAlgorithm WRITE setValidatingAlgorithm)
  friend class DataSelector;
 
public:
  using QComboBox::currentIndexChanged;
 
  WorkspaceSelector(QWidget *parent = nullptr, bool init = true);
  ~WorkspaceSelector() override;
 
  // delete copy operations - Poco::NObserver contains std::atomic which is not copyable
  WorkspaceSelector(const WorkspaceSelector &) = delete;
  WorkspaceSelector &operator=(const WorkspaceSelector &) = delete;
 
  const QStringList &getWorkspaceTypes() const;
  void setWorkspaceTypes(const QStringList &types);
  bool showHiddenWorkspaces() const;
  void showHiddenWorkspaces(bool show);
  bool showWorkspaceGroups() const;
  void showWorkspaceGroups(bool show);
  bool isOptional() const;
  void setOptional(bool optional);
  bool isSorted() const;
  void setSorted(bool sorted);
  const QStringList &getSuffixes() const;
  void setSuffixes(const QStringList &suffix);
  void setLowerBinLimit(int numberOfBins);
  void setUpperBinLimit(int numberOfBins);
  const QString &getValidatingAlgorithm() const;
  void setValidatingAlgorithm(const QString &algName);
  bool isValid() const;
  void refresh();
  void disconnectObservers();
  void connectObservers();
  bool isConnected() const;
 
signals:
  void emptied();
  void focussed();
 
private:
  void handleAddEvent(Mantid::API::WorkspaceAddNotification_ptr pNf);
  void handleRemEvent(Mantid::API::WorkspacePostDeleteNotification_ptr pNf);
  void handleClearEvent(Mantid::API::ClearADSNotification_ptr pNf);
  void handleRenameEvent(Mantid::API::WorkspaceRenameNotification_ptr pNf);
  void handleReplaceEvent(Mantid::API::WorkspaceAfterReplaceNotification_ptr pNf);
 
  bool checkEligibility(const QString &name, const Mantid::API::Workspace_sptr &object) const;
  bool hasValidSuffix(const QString &name) const;
  bool hasValidNumberOfBins(const Mantid::API::Workspace_sptr &object) const;
 
protected:
  // Method for handling drop events
  void dropEvent(QDropEvent * /*unused*/) override;
  // called when a drag event enters the class
  void dragEnterEvent(QDragEnterEvent * /*unused*/) override;
  // Method for handling focus in events
  void focusInEvent(QFocusEvent * /*unused*/) override;
 
private:
  Poco::NObserver<WorkspaceSelector, Mantid::API::WorkspaceAddNotification> m_addObserver;
  Poco::NObserver<WorkspaceSelector, Mantid::API::WorkspacePostDeleteNotification> m_remObserver;
  Poco::NObserver<WorkspaceSelector, Mantid::API::ClearADSNotification> m_clearObserver;
  Poco::NObserver<WorkspaceSelector, Mantid::API::WorkspaceRenameNotification> m_renameObserver;
  Poco::NObserver<WorkspaceSelector, Mantid::API::WorkspaceAfterReplaceNotification> m_replaceObserver;
 
  bool m_init;
  bool m_connected;
 
  QStringList m_workspaceTypes;
  bool m_showHidden;
  // show/hide workspace groups
  bool m_showGroups;
  bool m_optional;
  bool m_sorted;
  std::pair<int, int> m_binLimits;
  QStringList m_suffix;
  QString m_algName;
  QString m_algPropName;
 
  // Algorithm to validate against
  std::shared_ptr<Mantid::API::Algorithm> m_algorithm;
 
  // Mutex for synchronized event handling
  std::mutex m_adsMutex;
};
} // namespace MantidWidgets
} // namespace MantidQt