ScopedWorkspace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 <string>
 
#include "MantidAPI/DllConfig.h"
 
#include "MantidAPI/Workspace_fwd.h"
 
namespace Mantid {
namespace API {
class MANTID_API_DLL ScopedWorkspace {
public:
  ScopedWorkspace();
 
  ScopedWorkspace(const Workspace_sptr &ws);
 
  virtual ~ScopedWorkspace();
 
  ScopedWorkspace(const ScopedWorkspace &) = delete;
 
  ScopedWorkspace &operator=(const ScopedWorkspace &) = delete;
 
  const std::string &name() const { return m_name; }
 
  Workspace_sptr retrieve() const;
 
  void remove();
 
  operator bool() const;
 
  void set(const Workspace_sptr &newWS);
 
private:
  const std::string m_name;
 
  static std::string generateUniqueName();
 
  static const size_t NAME_LENGTH;
};
 
} // namespace API
} // namespace Mantid