CopyInstrumentParameters.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/Instrument.h"
 
#include <climits>
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL CopyInstrumentParameters final : public API::Algorithm {
public:
  const std::string name() const override { return "CopyInstrumentParameters"; }
  const std::string summary() const override {
    return "Transfers an instrument from on workspace to another workspace "
           "with same base instrument.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"ClearInstrumentParameters"}; }
  const std::string category() const override { return "DataHandling\\Instrument"; } // Needs to change
  bool isInstrumentDifferent() const { return m_different_instrument_sp; }
 
protected:
  Parallel::ExecutionMode
  getParallelExecutionMode(const std::map<std::string, Parallel::StorageMode> &storageModes) const override;
 
private:
  void init() override;
  void exec() override;
 
  void checkProperties();
 
  API::MatrixWorkspace_sptr m_givingWorkspace;
  API::MatrixWorkspace_sptr m_receivingWorkspace;
  bool m_different_instrument_sp = false;
};
 
} // namespace Algorithms
} // namespace Mantid