Workspace.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 "MantidAPI/DllConfig.h"
#include "MantidAPI/Workspace_fwd.h"
#include "MantidKernel/DataItem.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Mantid {
 
namespace Kernel {
class Logger;
}
 
namespace API {
class AnalysisDataServiceImpl;
class WorkspaceHistory;
 
class MANTID_API_DLL Workspace : public Kernel::DataItem {
public:
  Workspace();
  ~Workspace() override;
 
  Workspace_uptr clone() const { return Workspace_uptr(doClone()); }
 
  Workspace_uptr cloneEmpty() const { return Workspace_uptr(doCloneEmpty()); }
 
  Workspace &operator=(const Workspace &other) = delete;
  // DataItem interface
  bool threadSafe() const override { return true; }
 
  void virtual setTitle(const std::string &);
  void setComment(const std::string &);
  void setPythonVariableName(const std::string &);
  virtual const std::string getTitle() const;
  const std::string &getComment() const;
  const std::string &getName() const override;
  const std::string &getPythonVariableName() const;
  bool isDirty(const int n = 1) const;
  virtual bool isGroup() const { return false; }
  virtual size_t getMemorySize() const = 0;
  std::string getMemorySizeAsStr() const;
 
  WorkspaceHistory &history() { return *m_history; }
  const WorkspaceHistory &getHistory() const { return *m_history; }
 
protected:
  Workspace(const Workspace &);
 
private:
  void setName(const std::string &);
  std::string m_title;
  std::string m_comment;
  std::string m_name;
  std::string m_pythonVariableName;
  std::unique_ptr<WorkspaceHistory> m_history;
 
  virtual Workspace *doClone() const = 0;
  virtual Workspace *doCloneEmpty() const = 0;
 
  friend class AnalysisDataServiceImpl;
};
 
} // namespace API
} // namespace Mantid
 
// Instantiated and exported by API/src/PropertyWithValue.cpp
MANTID_API_EXTERN_TEMPLATE(Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::API::Workspace>>);