-
Notifications
You must be signed in to change notification settings - Fork 122
/
GroupWorkspaces.h
64 lines (55 loc) · 2.34 KB
/
GroupWorkspaces.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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/Algorithm.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidAPI/WorkspaceProperty.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidKernel/ArrayProperty.h"
namespace Mantid {
namespace Algorithms {
/** Takes workspaces as input and groups the workspaces.
Required Properties:
<UL>
<LI> InputWorkspaces - The name of the workspaces to group </LI>
<LI> OutputWorkspace - The name of the new group workspace created </LI>
</UL>
*/
class MANTID_ALGORITHMS_DLL GroupWorkspaces : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "GroupWorkspaces"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Takes workspaces as input and groups similar workspaces together.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override { return {"UnGroupWorkspace"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Transforms\\Grouping;Utility\\Workspaces"; }
std::map<std::string, std::string> validateInputs() override;
protected:
Parallel::ExecutionMode
getParallelExecutionMode(const std::map<std::string, Parallel::StorageMode> &storageModes) const override;
private:
/// Overridden Init method
void init() override;
/// overridden execute method
void exec() override;
/// Add a list of names to the new group
void addToGroup(const std::vector<std::string> &names);
/// Add a workspace to the new group, checking for a WorkspaceGroup and
/// unrolling it
void addToGroup(const API::Workspace_sptr &workspace);
/// Use a glob pattern to select workspaces in the ADS
void addToGroup(const std::string &globExpression);
/// A pointer to the new group
API::WorkspaceGroup_sptr m_group;
};
} // namespace Algorithms
} // namespace Mantid