ProjectSaveModel.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidAPI/Workspace.h"
#include "MantidQtWidgets/Common/IProjectSerialisable.h"
#include "MantidQtWidgets/Common/pixmaps.h"
 
#include "DllOption.h"
#include <unordered_map>
#include <vector>
 
namespace MantidQt {
namespace MantidWidgets {
 
// POD structs to pass information to the view
//==============================================================================
 
struct WorkspaceInfo {
  std::string name;
  std::string type;
  std::string size;
  std::string icon_id;
  size_t numWindows;
  std::vector<WorkspaceInfo> subWorkspaces;
 
  bool operator==(const WorkspaceInfo &b) const { return name == b.name; }
};
 
struct WindowInfo {
  std::string name;
  std::string type;
  std::string icon_id;
 
  bool operator==(const WindowInfo &b) const { return name == b.name; }
};
 
// Model definition
//==============================================================================
 
class EXPORT_OPT_MANTIDQT_COMMON ProjectSaveModel {
public:
  ProjectSaveModel(const std::vector<MantidQt::API::IProjectSerialisable *> &windows,
                   std::vector<std::string> activePythonInterfaces = std::vector<std::string>());
 
  bool hasWindows(const std::string &ws) const;
  std::vector<std::string> getWindowNames(const std::vector<std::string> &wsNames) const;
  std::vector<std::string> getWorkspaceNames() const;
  std::vector<std::string> getAllPythonInterfaces() const;
  std::vector<WindowInfo> getWindowInformation(const std::vector<std::string> &wsNames,
                                               bool includeUnattached = false) const;
  std::vector<WorkspaceInfo> getWorkspaceInformation() const;
  std::vector<MantidQt::API::IProjectSerialisable *> getWindows(const std::string &wsName) const;
  std::vector<MantidQt::API::IProjectSerialisable *> getUniqueWindows(const std::vector<std::string> &wsNames) const;
  std::vector<Mantid::API::Workspace_sptr> getWorkspaces() const;
  bool needsSizeWarning(const std::vector<std::string> &wsNames);
  virtual size_t getProjectSize(const std::vector<std::string> &wsNames);
 
private:
  WorkspaceInfo makeWorkspaceInfoObject(const Mantid::API::Workspace_const_sptr &ws) const;
 
  WindowInfo makeWindowInfoObject(MantidQt::API::IProjectSerialisable *window) const;
 
  // Instance variables
 
  std::unordered_map<std::string, std::vector<MantidQt::API::IProjectSerialisable *>> m_workspaceWindows;
 
  std::vector<MantidQt::API::IProjectSerialisable *> m_unattachedWindows;
  std::vector<std::string> m_activePythonInterfaces;
};
 
} // namespace MantidWidgets
} // namespace MantidQt