SetCrystalLocation.h

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//     NScD Oak Ridge National Laboratory, European Spallation Source
//     & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
/*
 * SetCrystalLocation.h
 *
 *  Created on: Dec 12, 2018
 *      Author: Brendan Sullivan
 */

#ifndef SETCRYSTALLOCATION_H_
#define SETCRYSTALLOCATION_H_

#include "MantidAPI/Algorithm.h"
#include "MantidKernel/System.h"

namespace Mantid {
namespace Crystal {

/** SetCrystalLocation

Description:
This algorithm provides a convenient interface to sets the
sample position of an events workspace.
@author Brendan Sullivan, SNS,ORNL
@date Dec 20 2018
*/
class DLLExport SetCrystalLocation : public API::Algorithm {
public:
  const std::string name() const override { return "SetCrystalLocation"; };
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "This algorithm sets the sample location of the "
           "input event workspace.";
  }
  const std::vector<std::string> seeAlso() const override {
    return {"OptimizeCrystalPlacement"};
  }

  int version() const override { return 1; };

  const std::string category() const override {
    return "Crystal\\Corrections";
  };

private:
  void init() override;

  void exec() override;
};
} // namespace Crystal
} // namespace Mantid

#endif /* SETCRYSTALLOCATION_H_ */