ClearUB.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 "MantidCrystal/DllConfig.h"
 
namespace Mantid {
 
namespace API {
class ExperimentInfo;
}
 
namespace Crystal {
 
class MANTID_CRYSTAL_DLL ClearUB : public API::Algorithm {
public:
  virtual ~ClearUB() = default;
  const std::string name() const override;
  const std::string summary() const override {
    return "Clears the UB by removing the oriented lattice from the sample.";
  }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"SetUB", "HasUB"}; }
  const std::string category() const override;
 
protected:
  bool doExecute(Mantid::API::Workspace *const ws, bool dryRun);
 
private:
  bool clearSingleExperimentInfo(Mantid::API::ExperimentInfo *const experimentInfo, const bool dryRun) const;
  void init() override;
  void exec() override;
};
 
} // namespace Crystal
} // namespace Mantid