Mantid
Loading...
Searching...
No Matches
DeleteWorkspace.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2001 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
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
22class MANTID_ALGORITHMS_DLL DeleteWorkspace : public API::DistributedAlgorithm {
23public:
25 const std::string name() const override { return "DeleteWorkspace"; }
27 const std::string summary() const override { return "Removes a workspace from memory."; }
28
30 const std::string category() const override { return "Utility\\Workspaces"; }
32 int version() const override { return 1; }
33 const std::vector<std::string> seeAlso() const override { return {"DeleteWorkspaces"}; }
34
35private:
37 void init() override;
39 void exec() override;
40
41 const std::string workspaceMethodName() const override { return "delete"; }
42 const std::string workspaceMethodInputProperty() const override { return "Workspace"; }
43
44 bool checkGroups() override;
45};
46
47} // namespace Algorithms
48} // namespace Mantid
Base class for algorithms that treat all spectra independently, i.e., we can trivially parallelize ov...
A simple algorithm to remove a workspace from the ADS.
const std::string name() const override
Algorithm's name.
const std::string workspaceMethodInputProperty() const override
Returns the name of the input workspace property used by the calling object.
const std::string workspaceMethodName() const override
const std::string summary() const override
Summary of algorithms purpose.
int version() const override
Algorithm's version 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.
Helper class which provides the Collimation Length for SANS instruments.