Newer
Older
Gigg, Martyn Anthony
committed
#ifndef MANTID_DATAHANDLING_CREATESAMPLESHAPE_H_
#define MANTID_DATAHANDLING_CREATESAMPLESHAPE_H_
//--------------------------------
// Includes
//--------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace DataHandling {
Gigg, Martyn Anthony
committed
/**
This class allows the shape of the sample to be defined by using the allowed
XML
Gigg, Martyn Anthony
committed
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
Gigg, Martyn Anthony
committed
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>
Gigg, Martyn Anthony
committed
*/
class DLLExport CreateSampleShape : public Mantid::API::Algorithm {
Gigg, Martyn Anthony
committed
public:
/// (Empty) Constructor
CreateSampleShape() : Mantid::API::Algorithm() {}
/// Virtual destructor
~CreateSampleShape() override {}
Gigg, Martyn Anthony
committed
/// Algorithm's name
const std::string name() const override { return "CreateSampleShape"; }
const std::string summary() const override {
return "Create a shape object to model the sample.";
}
Gigg, Martyn Anthony
committed
/// Algorithm's version
int version() const override { return (1); }
Gigg, Martyn Anthony
committed
/// Algorithm's category for identification
const std::string category() const override { return "Sample;"; }
Gigg, Martyn Anthony
committed
private:
/// Initialisation code
Gigg, Martyn Anthony
committed
};
}
}
#endif /* MANTID_DATAHANDLING_CREATESAMPLESHAPE_H_*/