MultiPeriodGroupWorker.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 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 "MantidKernel/System.h"
#include <memory>
#include <string>
#include <vector>
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL MultiPeriodGroupWorker {
public:
  using VecWSGroupType = std::vector<WorkspaceGroup_sptr>;
  MultiPeriodGroupWorker() = default;
  MultiPeriodGroupWorker(std::string workspacePropertyName);
  virtual ~MultiPeriodGroupWorker() = default;
  bool useCustomWorkspaceProperty() const;
  VecWSGroupType findMultiPeriodGroups(Algorithm const *const sourceAlg) const;
  bool processGroups(Algorithm *const sourceAlg, const VecWSGroupType &vecMultiPeriodGroups) const;
 
private:
  // Disable copy
  MultiPeriodGroupWorker(const MultiPeriodGroupWorker &);
  // Disable assignment
  MultiPeriodGroupWorker &operator=(const MultiPeriodGroupWorker &);
 
  void tryAddInputWorkspaceToInputGroups(const Workspace_sptr &ws, VecWSGroupType &vecMultiPeriodWorkspaceGroups,
                                         VecWSGroupType &vecWorkspaceGroups) const;
 
  void copyInputWorkspaceProperties(IAlgorithm *targetAlg, IAlgorithm *sourceAlg, const int &periodNumber) const;
 
  std::string createFormattedInputWorkspaceNames(const size_t &periodIndex,
                                                 const VecWSGroupType &vecWorkspaceGroups) const;
 
  void validateMultiPeriodGroupInputs(const VecWSGroupType &vecMultiPeriodGroups) const;
 
  std::string m_workspacePropertyName;
};
 
} // namespace API
} // namespace Mantid