ScopedWorkspace.cpp

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 +
#include <utility>
 
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/ScopedWorkspace.h"
#include "MantidAPI/WorkspaceGroup.h"
 
namespace Mantid::API {
 
const size_t ScopedWorkspace::NAME_LENGTH = 16;
 
//----------------------------------------------------------------------------------------------
ScopedWorkspace::ScopedWorkspace() : m_name(generateUniqueName()) {}
 
ScopedWorkspace::ScopedWorkspace(const Workspace_sptr &ws) : m_name(generateUniqueName()) { set(ws); }
 
//----------------------------------------------------------------------------------------------
ScopedWorkspace::~ScopedWorkspace() { remove(); }
 
ScopedWorkspace::operator bool() const { return AnalysisDataService::Instance().doesExist(m_name); }
 
Workspace_sptr ScopedWorkspace::retrieve() const {
  AnalysisDataServiceImpl &ads = AnalysisDataService::Instance();
 
  if (ads.doesExist(m_name)) {
    return ads.retrieveWS<Workspace>(m_name);
  }
 
  return Workspace_sptr();
}
 
void ScopedWorkspace::remove() {
  AnalysisDataServiceImpl &ads = AnalysisDataService::Instance();
 
  // When destructed, remove workspace from the ADS if was added and still
  // exists
  if (ads.doesExist(m_name)) {
    if (ads.retrieveWS<WorkspaceGroup>(m_name)) {
      // If is a group, need to remove all the members as well
      ads.deepRemoveGroup(m_name);
    } else {
      ads.remove(m_name);
    }
  }
}
 
void ScopedWorkspace::set(const Workspace_sptr &newWS) {
  AnalysisDataServiceImpl &ads = AnalysisDataService::Instance();
 
  if (!newWS->getName().empty() && ads.doesExist(newWS->getName()))
    throw std::invalid_argument("Workspace is already in the ADS under the name " + newWS->getName());
 
  // Remove previous workspace entry
  remove();
 
  ads.add(m_name, newWS);
}
 
std::string ScopedWorkspace::generateUniqueName() {
  std::string newName;
 
  do {
    // __ makes it hidden in the MantidPlot
    newName = "__ScopedWorkspace_" + randomString(NAME_LENGTH);
  } while (AnalysisDataService::Instance().doesExist(newName));
 
  return newName;
}
 
std::string ScopedWorkspace::randomString(size_t len) {
  static const std::string alphabet = "0123456789abcdefghijklmnopqrstuvwxyz";
 
  std::string result;
  result.reserve(len);
 
  while (result.size() != len) {
    size_t randPos = ((rand() % (alphabet.size() - 1)));
    result.push_back(alphabet[randPos]);
  }
 
  return result;
}
 
} // namespace Mantid::API