RemoveWorkspaceHistory.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 "MantidAlgorithms/RemoveWorkspaceHistory.h"
#include "MantidAPI/Workspace.h"
#include "MantidAPI/WorkspaceHistory.h"
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
 
namespace Mantid::Algorithms {
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(RemoveWorkspaceHistory)
 
 
const std::string RemoveWorkspaceHistory::name() const { return "RemoveWorkspaceHistory"; }
 
int RemoveWorkspaceHistory::version() const { return 1; }
 
const std::string RemoveWorkspaceHistory::category() const { return "Utility\\Workspaces"; }
 
const std::string RemoveWorkspaceHistory::summary() const {
  return "Removes all algorithm history records from a given workspace.";
}
 
void RemoveWorkspaceHistory::init() {
  declareProperty(std::make_unique<WorkspaceProperty<Workspace>>("Workspace", "", Direction::InOut),
                  "Workspace to remove the algorithm history from.");
}
 
void RemoveWorkspaceHistory::exec() {
  Workspace_sptr ws = getProperty("Workspace");
  ws->history().clearHistory();
}
 
} // namespace Mantid::Algorithms