Workspace.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 "MantidAPI/Workspace.h"
#include "MantidAPI/WorkspaceHistory.h"
#include "MantidKernel/IPropertyManager.h"
#include "MantidKernel/Memory.h"
 
namespace Mantid::API {
 
Workspace::Workspace(const Parallel::StorageMode storageMode)
    : m_history(std::make_unique<WorkspaceHistory>()), m_storageMode(storageMode) {}
 
// Defined as default in source for forward declaration with std::unique_ptr.
Workspace::~Workspace() = default;
 
Workspace::Workspace(const Workspace &other)
    : Kernel::DataItem(other), m_title(other.m_title), m_comment(other.m_comment), m_name(),
      m_history(std::make_unique<WorkspaceHistory>(other.getHistory())), m_storageMode(other.m_storageMode) {}
 
void Workspace::setTitle(const std::string &t) { m_title = t; }
 
void Workspace::setComment(const std::string &c) { m_comment = c; }
 
void Workspace::setName(const std::string &name) { m_name = name; }
 
const std::string Workspace::getTitle() const { return m_title; }
 
const std::string &Workspace::getComment() const { return m_comment; }
 
const std::string &Workspace::getName() const { return m_name; }
 
bool Workspace::isDirty(const int n) const { return static_cast<int>(m_history->size()) > n; }
 
std::string Workspace::getMemorySizeAsStr() const {
  return Mantid::Kernel::memToString<uint64_t>(static_cast<uint64_t>(getMemorySize()) / 1024);
}
 
Parallel::StorageMode Workspace::storageMode() const { return m_storageMode; }
 
void Workspace::setStorageMode(Parallel::StorageMode storageMode) { m_storageMode = storageMode; }
 
} // namespace Mantid::API
 
namespace Mantid::Kernel {
 
template <>
MANTID_API_DLL Mantid::API::Workspace_sptr
IPropertyManager::getValue<Mantid::API::Workspace_sptr>(const std::string &name) const {
  auto *prop = dynamic_cast<PropertyWithValue<Mantid::API::Workspace_sptr> *>(getPointerToProperty(name));
  if (prop) {
    return *prop;
  } else {
    std::string message = "Attempt to assign property " + name + " to incorrect type. Expected shared_ptr<Workspace>.";
    throw std::runtime_error(message);
  }
}
 
template <>
MANTID_API_DLL Mantid::API::Workspace_const_sptr
IPropertyManager::getValue<Mantid::API::Workspace_const_sptr>(const std::string &name) const {
  auto *prop = dynamic_cast<PropertyWithValue<Mantid::API::Workspace_sptr> *>(getPointerToProperty(name));
  if (prop) {
    return prop->operator()();
  } else {
    std::string message =
        "Attempt to assign property " + name + " to incorrect type. Expected const shared_ptr<Workspace>.";
    throw std::runtime_error(message);
  }
}
 
} // namespace Mantid::Kernel