MantidTreeModel.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2017 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 "MantidQtWidgets/Common/AlgorithmDialog.h"
#include "MantidQtWidgets/Common/DllOption.h"
#include "MantidQtWidgets/Common/MantidDisplayBase.h"
 
#include <QHash>
#include <QObject>
 
//----------------------------------
// Forward declarations
//----------------------------------
 
namespace MantidQt {
namespace MantidWidgets {
 
class MantidWSIndexDialog;
 
class EXPORT_OPT_MANTIDQT_COMMON MantidTreeModel : public QObject, public MantidQt::MantidWidgets::MantidDisplayBase {
  Q_OBJECT
 
public:
  MantidTreeModel();
 
  // Data display and saving methods
  void updateRecentFilesList(const QString &fname) override;
  void deleteWorkspaces(const QStringList &wsNames = QStringList()) override;
 
  // Algorithm Display and Execution Methods
  Mantid::API::IAlgorithm_sptr createAlgorithm(const QString &algName, int version = -1) override;
 
  bool executeAlgorithmAsync(Mantid::API::IAlgorithm_sptr alg, const bool wait = false) override;
 
  Mantid::API::Workspace_const_sptr getWorkspace(const QString &workspaceName) override;
  QWidget *getParent() override;
 
  MantidQt::API::AlgorithmDialog *createAlgorithmDialog(const Mantid::API::IAlgorithm_sptr &alg);
 
  // Plotting Methods
  MultiLayer *plotSubplots(const QMultiMap<QString, std::set<int>> &toPlot,
                           MantidQt::DistributionFlag distr = MantidQt::DistributionDefault, bool errs = false,
                           MultiLayer *plotWindow = nullptr) override;
 
public slots:
  // Data display and saving methods
  void enableSaveNexus(const QString &wsName) override;
  void disableSaveNexus() override;
  void importWorkspace() override;
 
  MantidMatrix *importMatrixWorkspace(const Mantid::API::MatrixWorkspace_sptr workspace, int lower = -1, int upper = -1,
                                      bool showDlg = true) override;
 
  void importWorkspace(const QString &wsName, bool showDlg = true, bool makeVisible = true) override;
 
  void showMantidInstrumentSelected() override;
  Table *createDetectorTable(const QString &wsName, const std::vector<int> &indices,
                             bool include_data = false) override;
  void importBoxDataTable() override;
  void showListData() override;
  void importTransposed() override;
  void renameWorkspace(QStringList /*unused*/ = QStringList()) override;
 
  // Algorithm Display and Execution Methods
  void showAlgorithmDialog(const QString &algName, int version = -1) override;
  void showAlgorithmDialog(const QString &algName, QHash<QString, QString> paramList,
                           Mantid::API::AlgorithmObserver *obs = nullptr, int version = -1) override;
  void executeAlgorithm(Mantid::API::IAlgorithm_sptr alg) override;
 
  // Plotting Methods
  MultiLayer *plot1D(const QMultiMap<QString, std::set<int>> &toPlot, bool spectrumPlot,
                     MantidQt::DistributionFlag distr = MantidQt::DistributionDefault, bool errs = false,
                     MultiLayer *plotWindow = nullptr, bool clearWindow = false, bool waterfallPlot = false,
                     const QString &log = "", const std::set<double> &customLogValues = std::set<double>()) override;
 
  void drawColorFillPlots(const QStringList &wsNames,
                          GraphOptions::CurveType curveType = GraphOptions::ColorMap) override;
 
  void showMDPlot() override;
 
  void plotSurface(bool accepted, int plotIndex, const QString &axisName, const QString &logName,
                   const std::set<double> &customLogValues, const QList<QString> &workspaceNames) override;
 
  void plotContour(bool accepted, int plotIndex, const QString &axisName, const QString &logName,
                   const std::set<double> &customLogValues, const QList<QString> &workspaceNames) override;
 
  // Inteface methods
  // ONLY REQUIRED TO STATIFY MantidDisplayBase INTERFACE
  void showSpectrumViewer() override;
  void showSliceViewer() override;
  void showLogFileWindow() override;
  void showSampleMaterialWindow() override;
  void showAlgorithmHistory() override;
 
  MantidQt::MantidWidgets::MantidWSIndexDialog *createWorkspaceIndexDialog(int flags, const QStringList &wsNames,
                                                                           bool showWaterfall, bool showPlotAll,
                                                                           bool showTiledOpt,
                                                                           bool isAdvanced = false) override;
 
  void updateProject() override;
  void showCritical(const QString & /*unused*/) override;
 
private:
  // overide copy operations
  MantidTreeModel(const MantidTreeModel &);
  MantidTreeModel &operator=(const MantidTreeModel &);
};
} // namespace MantidWidgets
} // namespace MantidQt