GroupWorkspaces.h

Go to the documentation of this file.

// 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 {
 
class MANTID_ALGORITHMS_DLL GroupWorkspaces final : public API::Algorithm {
public:
  const std::string name() const override { return "GroupWorkspaces"; }
  const std::string summary() const override {
    return "Takes workspaces as input and groups similar workspaces together.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"UnGroupWorkspace"}; }
  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:
  void init() override;
  void exec() override;
  void addToGroup(const std::vector<std::string> &names);
  void addToGroup(const API::Workspace_sptr &workspace);
  void addToGroup(const std::string &globExpression);
  API::WorkspaceGroup_sptr m_group;
};
 
} // namespace Algorithms
} // namespace Mantid