Mantid
Loading...
Searching...
No Matches
RenameWorkspaces.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidAlgorithms/DllConfig.h"
14
15namespace Mantid {
16namespace Algorithms {
33class MANTID_ALGORITHMS_DLL RenameWorkspaces final : public API::Algorithm {
34public:
36 const std::string name() const override { return "RenameWorkspaces"; }
38 const std::string summary() const override {
39 return "Rename the Workspace. Please provide either a comma-separated list "
40 "of new workspace names in WorkspaceNames or Prefix and/or Suffix "
41 "to add to existing names";
42 }
43
45 int version() const override { return (1); }
46 const std::vector<std::string> seeAlso() const override { return {"RenameWorkspace"}; }
48 const std::string category() const override { return "Utility\\Workspaces"; }
49
51 std::map<std::string, std::string> validateInputs() override;
52
53private:
54 // Overridden Algorithm methods
55 void init() override;
56 void exec() override;
57};
58
59} // namespace Algorithms
60} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Renames a workspace to a different name in the data service.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
Helper class which provides the Collimation Length for SANS instruments.