CopySample.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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/Sample.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL CopySample final : public API::Algorithm {
public:
  const std::string name() const override { return "CopySample"; };
  const std::string summary() const override {
    return "Copy some/all the sample information from one workspace to "
           "another.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"CompareSampleLogs", "CopyLogs", "CheckForSampleLogs"};
  }
  const std::string category() const override { return "Sample;Utility\\Workspaces"; }
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void init() override;
  void exec() override;
  void copyParameters(API::Sample &from, API::Sample &to, bool nameFlag, bool materialFlag, bool environmentFlag,
                      bool shapeFlag, bool latticeFlag, bool orientationOnlyFlag,
                      const Kernel::Matrix<double> &rotationMatrix);
};
 
} // namespace Algorithms
} // namespace Mantid