Mantid
Loading...
Searching...
No Matches
CreateSampleShape.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9//--------------------------------
10// Includes
11//--------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidDataHandling/DllConfig.h"
14
15namespace Mantid {
16namespace API {
17class ExperimentInfo;
18}
19namespace DataHandling {
20
28class MANTID_DATAHANDLING_DLL CreateSampleShape final : public API::Algorithm {
29public:
30 static void setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML);
31
32public:
33 const std::string name() const override { return "CreateSampleShape"; }
34 const std::string summary() const override { return "Create a shape object to model the sample."; }
35
36 int version() const override { return (1); }
37 const std::vector<std::string> seeAlso() const override {
38 return {"SetSample", "AbsorptionCorrection", "SetSampleMaterial", "CopySample"};
39 }
40 const std::string category() const override { return "Sample;"; }
41 const std::string alias() const override { return "SetSampleShape"; }
42
43private:
44 void init() override;
45 void exec() override;
46};
47
48} // namespace DataHandling
49} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
This class is shared by a few Workspace types and holds information related to a particular experimen...
This class allows the shape of the sample to be defined by using the allowed XML expressions.
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
const std::string alias() const override
function to return any aliases to the algorithm; A default implementation is provided
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string category() const override
function to return a category of the algorithm.
Helper class which provides the Collimation Length for SANS instruments.