Skip to content
Snippets Groups Projects
CreateSampleShape.h 2.17 KiB
Newer Older
#ifndef MANTID_DATAHANDLING_CREATESAMPLESHAPE_H_
#define MANTID_DATAHANDLING_CREATESAMPLESHAPE_H_

//--------------------------------
// Includes
//--------------------------------
#include "MantidAPI/Algorithm.h"

namespace Mantid {
namespace DataHandling {
/**
    This class allows the shape of the sample to be defined by using the allowed
   XML
    expressions

    @author Martyn Gigg, Tessella Support Services plc
    @date 13/03/2009

    Copyright © 2009 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
   National Laboratory & European Spallation Source

    This file is part of Mantid.

    Mantid is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    Mantid is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    File change history is stored at: <https://github.com/mantidproject/mantid>
    Code Documentation is available at: <http://doxygen.mantidproject.org>
class DLLExport CreateSampleShape : public Mantid::API::Algorithm {
public:
  /// (Empty) Constructor
  CreateSampleShape() : Mantid::API::Algorithm() {}
  /// Virtual destructor
  ~CreateSampleShape() override {}
  const std::string name() const override { return "CreateSampleShape"; }
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Create a shape object to model the sample.";
  }
  int version() const override { return (1); }
  const std::string category() const override { return "Sample;"; }
  void init() override;
  /// Execution code
  void exec() override;