RenameWorkspace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidAPI/DistributedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL RenameWorkspace : public API::DistributedAlgorithm {
public:
  const std::string name() const override { return "RenameWorkspace"; }
  const std::string summary() const override { return "Rename the Workspace."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"RenameWorkspaces"}; }
  const std::string category() const override { return "Utility\\Workspaces"; }
  std::map<std::string, std::string> validateInputs() override;
 
private:
  const std::string workspaceMethodName() const override { return "rename"; }
  const std::string workspaceMethodInputProperty() const override { return "InputWorkspace"; }
 
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  bool processGroups() override;
};
 
} // namespace Algorithms
} // namespace Mantid