DeleteLog.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/DeleteLog.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/Run.h"
#include "MantidKernel/MandatoryValidator.h"
 
namespace Mantid::Algorithms {
using namespace API;
using namespace Kernel;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(DeleteLog)
 
 
const std::string DeleteLog::name() const { return "DeleteLog"; }
 
int DeleteLog::version() const { return 1; }
 
const std::string DeleteLog::category() const { return "DataHandling\\Logs"; }
 
void DeleteLog::init() {
  declareProperty(std::make_unique<WorkspaceProperty<>>("Workspace", "", Direction::InOut),
                  "In/out workspace containing the logs. The workspace is "
                  "modified in place");
  declareProperty("Name", "", std::make_shared<MandatoryValidator<std::string>>(), "", Direction::Input);
}
 
void DeleteLog::exec() {
  MatrixWorkspace_sptr logWS = getProperty("Workspace");
  std::string logName = getProperty("Name");
  auto &run = logWS->mutableRun();
  if (run.hasProperty(logName)) {
    run.removeLogData(logName);
  } else {
    g_log.warning() << "Unable to delete log '" << logName << "' from the given workspace as it does not exist.\n";
  }
}
 
} // namespace Mantid::Algorithms