Mantid
Loading...
Searching...
No Matches
DefineGaugeVolume.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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 DataHandling {
17
26class MANTID_DATAHANDLING_DLL DefineGaugeVolume final : public API::Algorithm {
27public:
29 const std::string name() const override { return "DefineGaugeVolume"; }
31 const std::string summary() const override {
32 return "Defines a geometrical shape object to be used as the gauge volume "
33 "in the AbsorptionCorrection algorithm.";
34 }
35
37 int version() const override { return (1); }
38 const std::vector<std::string> seeAlso() const override { return {"AbsorptionCorrection"}; }
40 const std::string category() const override { return "Sample"; }
41
42private:
44 void init() override;
46 void exec() override;
47};
48} // namespace DataHandling
49} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
This class allows the shape of the sample to be defined by using the allowed XML expressions.
const std::string category() const override
Algorithm's category for identification.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
int version() const override
Algorithm's version.
const std::string summary() const override
Summary of algorithms purpose.
const std::string name() const override
Algorithm's name.
Helper class which provides the Collimation Length for SANS instruments.